blob: 6df6e7a6ecc0f8396440db1b53b300e29b5dd391 [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*/
danf52bb8d2013-08-03 20:24:58 +0000259typedef struct Stat4Accum Stat4Accum;
danf00e9022013-08-14 19:54:12 +0000260typedef struct Stat4Sample Stat4Sample;
261struct Stat4Sample {
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};
danf52bb8d2013-08-03 20:24:58 +0000276struct Stat4Accum {
drhade3add2011-08-13 00:58:05 +0000277 tRowcnt nRow; /* Number of rows in the entire table */
278 tRowcnt nPSample; /* How often to do a periodic sample */
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 */
drhade3add2011-08-13 00:58:05 +0000281 int mxSample; /* Maximum number of samples to accumulate */
danf00e9022013-08-14 19:54:12 +0000282 Stat4Sample current; /* Current row as a Stat4Sample */
drhf404c862011-08-13 15:25:10 +0000283 u32 iPrn; /* Pseudo-random number used for sampling */
drhebe25af2013-11-02 18:46:04 +0000284 Stat4Sample *aBest; /* Array of nCol best samples */
danf00e9022013-08-14 19:54:12 +0000285 int iMin; /* Index in a[] of entry with minimum score */
286 int nSample; /* Current number of samples */
danbd1d2702017-02-22 19:27:51 +0000287 int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
danf00e9022013-08-14 19:54:12 +0000288 int iGet; /* Index of current sample accessed by stat_get() */
289 Stat4Sample *a; /* Array of mxSample Stat4Sample objects */
drhebe25af2013-11-02 18:46:04 +0000290 sqlite3 *db; /* Database connection, for malloc() */
drhade3add2011-08-13 00:58:05 +0000291};
292
drhebe25af2013-11-02 18:46:04 +0000293/* Reclaim memory used by a Stat4Sample
294*/
drh175b8f02019-08-08 15:24:17 +0000295#ifdef SQLITE_ENABLE_STAT4
drhebe25af2013-11-02 18:46:04 +0000296static void sampleClear(sqlite3 *db, Stat4Sample *p){
drhda475b82013-11-04 21:44:54 +0000297 assert( db!=0 );
298 if( p->nRowid ){
299 sqlite3DbFree(db, p->u.aRowid);
300 p->nRowid = 0;
301 }
drhebe25af2013-11-02 18:46:04 +0000302}
303#endif
304
drhda475b82013-11-04 21:44:54 +0000305/* Initialize the BLOB value of a ROWID
drhebe25af2013-11-02 18:46:04 +0000306*/
drh175b8f02019-08-08 15:24:17 +0000307#ifdef SQLITE_ENABLE_STAT4
drhda475b82013-11-04 21:44:54 +0000308static void sampleSetRowid(sqlite3 *db, Stat4Sample *p, int n, const u8 *pData){
309 assert( db!=0 );
310 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
drh575fad62016-02-05 13:38:36 +0000311 p->u.aRowid = sqlite3DbMallocRawNN(db, n);
drhda475b82013-11-04 21:44:54 +0000312 if( p->u.aRowid ){
313 p->nRowid = n;
314 memcpy(p->u.aRowid, pData, n);
315 }else{
316 p->nRowid = 0;
317 }
318}
319#endif
320
321/* Initialize the INTEGER value of a ROWID.
322*/
drh175b8f02019-08-08 15:24:17 +0000323#ifdef SQLITE_ENABLE_STAT4
drhda475b82013-11-04 21:44:54 +0000324static void sampleSetRowidInt64(sqlite3 *db, Stat4Sample *p, i64 iRowid){
325 assert( db!=0 );
326 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
327 p->nRowid = 0;
328 p->u.iRowid = iRowid;
329}
330#endif
331
332
333/*
334** Copy the contents of object (*pFrom) into (*pTo).
335*/
drh175b8f02019-08-08 15:24:17 +0000336#ifdef SQLITE_ENABLE_STAT4
drhda475b82013-11-04 21:44:54 +0000337static void sampleCopy(Stat4Accum *p, Stat4Sample *pTo, Stat4Sample *pFrom){
338 pTo->isPSample = pFrom->isPSample;
339 pTo->iCol = pFrom->iCol;
340 pTo->iHash = pFrom->iHash;
341 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
342 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
343 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
344 if( pFrom->nRowid ){
345 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
346 }else{
347 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000348 }
349}
350#endif
351
352/*
353** Reclaim all memory of a Stat4Accum structure.
354*/
355static void stat4Destructor(void *pOld){
356 Stat4Accum *p = (Stat4Accum*)pOld;
drh175b8f02019-08-08 15:24:17 +0000357#ifdef SQLITE_ENABLE_STAT4
drhebe25af2013-11-02 18:46:04 +0000358 int i;
359 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
360 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
drhda475b82013-11-04 21:44:54 +0000361 sampleClear(p->db, &p->current);
drhebe25af2013-11-02 18:46:04 +0000362#endif
363 sqlite3DbFree(p->db, p);
364}
365
drhade3add2011-08-13 00:58:05 +0000366/*
drhec9e55d2014-06-30 17:07:39 +0000367** Implementation of the stat_init(N,K,C) SQL function. The three parameters
368** are:
drh553818a2014-07-23 18:36:55 +0000369** N: The number of columns in the index including the rowid/pk (note 1)
370** K: The number of columns in the index excluding the rowid/pk.
371** C: The number of rows in the index (note 2)
drhec9e55d2014-06-30 17:07:39 +0000372**
drh553818a2014-07-23 18:36:55 +0000373** Note 1: In the special case of the covering index that implements a
374** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
375** total number of columns in the table.
drhec9e55d2014-06-30 17:07:39 +0000376**
drh175b8f02019-08-08 15:24:17 +0000377** Note 2: C is only used for STAT4.
drh553818a2014-07-23 18:36:55 +0000378**
379** For indexes on ordinary rowid tables, N==K+1. But for indexes on
380** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
381** PRIMARY KEY of the table. The covering index that implements the
382** original WITHOUT ROWID table as N==K as a special case.
drhade3add2011-08-13 00:58:05 +0000383**
danf52bb8d2013-08-03 20:24:58 +0000384** This routine allocates the Stat4Accum object in heap memory. The return
peter.d.reid60ec9142014-09-06 16:39:46 +0000385** value is a pointer to the Stat4Accum object. The datatype of the
drhf8ede572014-09-01 23:06:44 +0000386** return value is BLOB, but it is really just a pointer to the Stat4Accum
387** object.
drhade3add2011-08-13 00:58:05 +0000388*/
danf00e9022013-08-14 19:54:12 +0000389static void statInit(
drhade3add2011-08-13 00:58:05 +0000390 sqlite3_context *context,
391 int argc,
392 sqlite3_value **argv
393){
danf52bb8d2013-08-03 20:24:58 +0000394 Stat4Accum *p;
danf52bb8d2013-08-03 20:24:58 +0000395 int nCol; /* Number of columns in index being sampled */
drhec9e55d2014-06-30 17:07:39 +0000396 int nKeyCol; /* Number of key columns */
drh9fecc542013-08-27 20:16:48 +0000397 int nColUp; /* nCol rounded up for alignment */
danf52bb8d2013-08-03 20:24:58 +0000398 int n; /* Bytes of space to allocate */
drhebe25af2013-11-02 18:46:04 +0000399 sqlite3 *db; /* Database connection */
drh175b8f02019-08-08 15:24:17 +0000400#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000401 int mxSample = SQLITE_STAT4_SAMPLES;
402#endif
drhade3add2011-08-13 00:58:05 +0000403
danf52bb8d2013-08-03 20:24:58 +0000404 /* Decode the three function arguments */
drh68257192011-08-16 17:06:21 +0000405 UNUSED_PARAMETER(argc);
drh9fecc542013-08-27 20:16:48 +0000406 nCol = sqlite3_value_int(argv[0]);
drhec9e55d2014-06-30 17:07:39 +0000407 assert( nCol>0 );
drh9fecc542013-08-27 20:16:48 +0000408 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
drhec9e55d2014-06-30 17:07:39 +0000409 nKeyCol = sqlite3_value_int(argv[1]);
410 assert( nKeyCol<=nCol );
411 assert( nKeyCol>0 );
danf52bb8d2013-08-03 20:24:58 +0000412
413 /* Allocate the space required for the Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000414 n = sizeof(*p)
drh9fecc542013-08-27 20:16:48 +0000415 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anEq */
416 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anDLt */
drh175b8f02019-08-08 15:24:17 +0000417#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000418 + sizeof(tRowcnt)*nColUp /* Stat4Accum.anLt */
drhebe25af2013-11-02 18:46:04 +0000419 + sizeof(Stat4Sample)*(nCol+mxSample) /* Stat4Accum.aBest[], a[] */
drh9fecc542013-08-27 20:16:48 +0000420 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample)
421#endif
422 ;
drhebe25af2013-11-02 18:46:04 +0000423 db = sqlite3_context_db_handle(context);
424 p = sqlite3DbMallocZero(db, n);
drhade3add2011-08-13 00:58:05 +0000425 if( p==0 ){
426 sqlite3_result_error_nomem(context);
427 return;
428 }
danf52bb8d2013-08-03 20:24:58 +0000429
drhebe25af2013-11-02 18:46:04 +0000430 p->db = db;
drh9fecc542013-08-27 20:16:48 +0000431 p->nRow = 0;
danf52bb8d2013-08-03 20:24:58 +0000432 p->nCol = nCol;
drhec9e55d2014-06-30 17:07:39 +0000433 p->nKeyCol = nKeyCol;
danf00e9022013-08-14 19:54:12 +0000434 p->current.anDLt = (tRowcnt*)&p[1];
drh9fecc542013-08-27 20:16:48 +0000435 p->current.anEq = &p->current.anDLt[nColUp];
danf00e9022013-08-14 19:54:12 +0000436
drh175b8f02019-08-08 15:24:17 +0000437#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000438 {
439 u8 *pSpace; /* Allocated space not yet assigned */
440 int i; /* Used to iterate through p->aSample[] */
danf52bb8d2013-08-03 20:24:58 +0000441
drh9fecc542013-08-27 20:16:48 +0000442 p->iGet = -1;
443 p->mxSample = mxSample;
drhec9e55d2014-06-30 17:07:39 +0000444 p->nPSample = (tRowcnt)(sqlite3_value_int64(argv[2])/(mxSample/3+1) + 1);
drh9fecc542013-08-27 20:16:48 +0000445 p->current.anLt = &p->current.anEq[nColUp];
drh4081d5d2015-01-01 23:02:01 +0000446 p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
drh9fecc542013-08-27 20:16:48 +0000447
448 /* Set up the Stat4Accum.a[] and aBest[] arrays */
449 p->a = (struct Stat4Sample*)&p->current.anLt[nColUp];
450 p->aBest = &p->a[mxSample];
451 pSpace = (u8*)(&p->a[mxSample+nCol]);
452 for(i=0; i<(mxSample+nCol); i++){
453 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
454 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
455 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
456 }
457 assert( (pSpace - (u8*)p)==n );
458
459 for(i=0; i<nCol; i++){
460 p->aBest[i].iCol = i;
461 }
danf00e9022013-08-14 19:54:12 +0000462 }
drh9fecc542013-08-27 20:16:48 +0000463#endif
danf00e9022013-08-14 19:54:12 +0000464
drhf8ede572014-09-01 23:06:44 +0000465 /* Return a pointer to the allocated object to the caller. Note that
466 ** only the pointer (the 2nd parameter) matters. The size of the object
467 ** (given by the 3rd parameter) is never used and can be any positive
468 ** value. */
drh975e0762014-09-01 22:34:54 +0000469 sqlite3_result_blob(context, p, sizeof(*p), stat4Destructor);
drhade3add2011-08-13 00:58:05 +0000470}
danf00e9022013-08-14 19:54:12 +0000471static const FuncDef statInitFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000472 2+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000473 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000474 0, /* pUserData */
475 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000476 statInit, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000477 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000478 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000479 "stat_init", /* zName */
drh80738d92016-02-15 00:34:16 +0000480 {0}
drhade3add2011-08-13 00:58:05 +0000481};
482
danb13af4c2013-09-03 14:43:12 +0000483#ifdef SQLITE_ENABLE_STAT4
484/*
485** pNew and pOld are both candidate non-periodic samples selected for
486** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
487** considering only any trailing columns and the sample hash value, this
488** function returns true if sample pNew is to be preferred over pOld.
489** In other words, if we assume that the cardinalities of the selected
490** column for pNew and pOld are equal, is pNew to be preferred over pOld.
491**
492** This function assumes that for each argument sample, the contents of
493** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
494*/
495static int sampleIsBetterPost(
496 Stat4Accum *pAccum,
497 Stat4Sample *pNew,
498 Stat4Sample *pOld
499){
500 int nCol = pAccum->nCol;
501 int i;
502 assert( pNew->iCol==pOld->iCol );
503 for(i=pNew->iCol+1; i<nCol; i++){
504 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
505 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
506 }
507 if( pNew->iHash>pOld->iHash ) return 1;
508 return 0;
509}
510#endif
511
drh175b8f02019-08-08 15:24:17 +0000512#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000513/*
514** Return true if pNew is to be preferred over pOld.
danb13af4c2013-09-03 14:43:12 +0000515**
516** This function assumes that for each argument sample, the contents of
517** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
danf00e9022013-08-14 19:54:12 +0000518*/
danb13af4c2013-09-03 14:43:12 +0000519static int sampleIsBetter(
520 Stat4Accum *pAccum,
521 Stat4Sample *pNew,
522 Stat4Sample *pOld
523){
danf00e9022013-08-14 19:54:12 +0000524 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
525 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
526
527 assert( pOld->isPSample==0 && pNew->isPSample==0 );
528 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
529
danb13af4c2013-09-03 14:43:12 +0000530 if( (nEqNew>nEqOld) ) return 1;
danb13af4c2013-09-03 14:43:12 +0000531 if( nEqNew==nEqOld ){
532 if( pNew->iCol<pOld->iCol ) return 1;
533 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
danf00e9022013-08-14 19:54:12 +0000534 }
535 return 0;
536}
drhade3add2011-08-13 00:58:05 +0000537
538/*
danf00e9022013-08-14 19:54:12 +0000539** Copy the contents of sample *pNew into the p->a[] array. If necessary,
540** remove the least desirable sample from p->a[] to make room.
541*/
542static void sampleInsert(Stat4Accum *p, Stat4Sample *pNew, int nEqZero){
drhd2694612013-11-04 22:04:17 +0000543 Stat4Sample *pSample = 0;
danf52bb8d2013-08-03 20:24:58 +0000544 int i;
danf52bb8d2013-08-03 20:24:58 +0000545
danf00e9022013-08-14 19:54:12 +0000546 assert( IsStat4 || nEqZero==0 );
danf52bb8d2013-08-03 20:24:58 +0000547
danbd1d2702017-02-22 19:27:51 +0000548 /* Stat4Accum.nMaxEqZero is set to the maximum number of leading 0
549 ** values in the anEq[] array of any sample in Stat4Accum.a[]. In
550 ** other words, if nMaxEqZero is n, then it is guaranteed that there
551 ** are no samples with Stat4Sample.anEq[m]==0 for (m>=n). */
danbd1d2702017-02-22 19:27:51 +0000552 if( nEqZero>p->nMaxEqZero ){
553 p->nMaxEqZero = nEqZero;
554 }
danf00e9022013-08-14 19:54:12 +0000555 if( pNew->isPSample==0 ){
dan1f616ad2013-08-15 14:39:09 +0000556 Stat4Sample *pUpgrade = 0;
danf00e9022013-08-14 19:54:12 +0000557 assert( pNew->anEq[pNew->iCol]>0 );
drhade3add2011-08-13 00:58:05 +0000558
danf00e9022013-08-14 19:54:12 +0000559 /* This sample is being added because the prefix that ends in column
560 ** iCol occurs many times in the table. However, if we have already
561 ** added a sample that shares this prefix, there is no need to add
dan1f616ad2013-08-15 14:39:09 +0000562 ** this one. Instead, upgrade the priority of the highest priority
563 ** existing sample that shares this prefix. */
danf00e9022013-08-14 19:54:12 +0000564 for(i=p->nSample-1; i>=0; i--){
565 Stat4Sample *pOld = &p->a[i];
566 if( pOld->anEq[pNew->iCol]==0 ){
dan1f616ad2013-08-15 14:39:09 +0000567 if( pOld->isPSample ) return;
danb13af4c2013-09-03 14:43:12 +0000568 assert( pOld->iCol>pNew->iCol );
569 assert( sampleIsBetter(p, pNew, pOld) );
570 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
dan1f616ad2013-08-15 14:39:09 +0000571 pUpgrade = pOld;
danf00e9022013-08-14 19:54:12 +0000572 }
dan1f28ead2013-08-07 16:15:32 +0000573 }
574 }
dan1f616ad2013-08-15 14:39:09 +0000575 if( pUpgrade ){
576 pUpgrade->iCol = pNew->iCol;
577 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
578 goto find_new_min;
579 }
drhade3add2011-08-13 00:58:05 +0000580 }
danf52bb8d2013-08-03 20:24:58 +0000581
danf00e9022013-08-14 19:54:12 +0000582 /* If necessary, remove sample iMin to make room for the new sample. */
583 if( p->nSample>=p->mxSample ){
584 Stat4Sample *pMin = &p->a[p->iMin];
danc55521a2013-08-05 05:34:30 +0000585 tRowcnt *anEq = pMin->anEq;
danc55521a2013-08-05 05:34:30 +0000586 tRowcnt *anLt = pMin->anLt;
danf00e9022013-08-14 19:54:12 +0000587 tRowcnt *anDLt = pMin->anDLt;
drhda475b82013-11-04 21:44:54 +0000588 sampleClear(p->db, pMin);
danf00e9022013-08-14 19:54:12 +0000589 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
drhf404c862011-08-13 15:25:10 +0000590 pSample = &p->a[p->nSample-1];
drhd2694612013-11-04 22:04:17 +0000591 pSample->nRowid = 0;
danc55521a2013-08-05 05:34:30 +0000592 pSample->anEq = anEq;
593 pSample->anDLt = anDLt;
594 pSample->anLt = anLt;
danf00e9022013-08-14 19:54:12 +0000595 p->nSample = p->mxSample-1;
dan8ad169a2013-08-12 20:14:04 +0000596 }
drhade3add2011-08-13 00:58:05 +0000597
danb49d1042013-09-02 18:58:11 +0000598 /* The "rows less-than" for the rowid column must be greater than that
599 ** for the last sample in the p->a[] array. Otherwise, the samples would
600 ** be out of order. */
danb49d1042013-09-02 18:58:11 +0000601 assert( p->nSample==0
602 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
danb49d1042013-09-02 18:58:11 +0000603
604 /* Insert the new sample */
605 pSample = &p->a[p->nSample];
606 sampleCopy(p, pSample, pNew);
607 p->nSample++;
608
danf00e9022013-08-14 19:54:12 +0000609 /* Zero the first nEqZero entries in the anEq[] array. */
610 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
611
drh175b8f02019-08-08 15:24:17 +0000612find_new_min:
danf00e9022013-08-14 19:54:12 +0000613 if( p->nSample>=p->mxSample ){
614 int iMin = -1;
danf52bb8d2013-08-03 20:24:58 +0000615 for(i=0; i<p->mxSample; i++){
616 if( p->a[i].isPSample ) continue;
danb13af4c2013-09-03 14:43:12 +0000617 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
drhade3add2011-08-13 00:58:05 +0000618 iMin = i;
drhade3add2011-08-13 00:58:05 +0000619 }
620 }
danf52bb8d2013-08-03 20:24:58 +0000621 assert( iMin>=0 );
drhade3add2011-08-13 00:58:05 +0000622 p->iMin = iMin;
623 }
624}
drh175b8f02019-08-08 15:24:17 +0000625#endif /* SQLITE_ENABLE_STAT4 */
danf00e9022013-08-14 19:54:12 +0000626
627/*
628** Field iChng of the index being scanned has changed. So at this point
629** p->current contains a sample that reflects the previous row of the
630** index. The value of anEq[iChng] and subsequent anEq[] elements are
631** correct at this point.
632*/
633static void samplePushPrevious(Stat4Accum *p, int iChng){
drh92707ac2013-08-17 18:57:15 +0000634#ifdef SQLITE_ENABLE_STAT4
635 int i;
danf00e9022013-08-14 19:54:12 +0000636
drh92707ac2013-08-17 18:57:15 +0000637 /* Check if any samples from the aBest[] array should be pushed
638 ** into IndexSample.a[] at this point. */
639 for(i=(p->nCol-2); i>=iChng; i--){
640 Stat4Sample *pBest = &p->aBest[i];
danb13af4c2013-09-03 14:43:12 +0000641 pBest->anEq[i] = p->current.anEq[i];
642 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
drh92707ac2013-08-17 18:57:15 +0000643 sampleInsert(p, pBest, i);
danf00e9022013-08-14 19:54:12 +0000644 }
645 }
646
danbd1d2702017-02-22 19:27:51 +0000647 /* Check that no sample contains an anEq[] entry with an index of
648 ** p->nMaxEqZero or greater set to zero. */
drh92707ac2013-08-17 18:57:15 +0000649 for(i=p->nSample-1; i>=0; i--){
650 int j;
danbd1d2702017-02-22 19:27:51 +0000651 for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
652 }
653
654 /* Update the anEq[] fields of any samples already collected. */
655 if( iChng<p->nMaxEqZero ){
656 for(i=p->nSample-1; i>=0; i--){
657 int j;
658 for(j=iChng; j<p->nCol; j++){
659 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
660 }
drh92707ac2013-08-17 18:57:15 +0000661 }
danbd1d2702017-02-22 19:27:51 +0000662 p->nMaxEqZero = iChng;
drh92707ac2013-08-17 18:57:15 +0000663 }
664#endif
665
drh175b8f02019-08-08 15:24:17 +0000666#ifndef SQLITE_ENABLE_STAT4
drh4f991892013-10-11 15:05:05 +0000667 UNUSED_PARAMETER( p );
668 UNUSED_PARAMETER( iChng );
669#endif
danf00e9022013-08-14 19:54:12 +0000670}
671
672/*
drhebe25af2013-11-02 18:46:04 +0000673** Implementation of the stat_push SQL function: stat_push(P,C,R)
drh9fecc542013-08-27 20:16:48 +0000674** Arguments:
danf00e9022013-08-14 19:54:12 +0000675**
drh9fecc542013-08-27 20:16:48 +0000676** P Pointer to the Stat4Accum object created by stat_init()
677** C Index of left-most column to differ from previous row
drhebe25af2013-11-02 18:46:04 +0000678** R Rowid for the current row. Might be a key record for
679** WITHOUT ROWID tables.
danf00e9022013-08-14 19:54:12 +0000680**
drh553818a2014-07-23 18:36:55 +0000681** This SQL function always returns NULL. It's purpose it to accumulate
682** statistical data and/or samples in the Stat4Accum object about the
683** index being analyzed. The stat_get() SQL function will later be used to
684** extract relevant information for constructing the sqlite_statN tables.
drh9fecc542013-08-27 20:16:48 +0000685**
drh175b8f02019-08-08 15:24:17 +0000686** The R parameter is only used for STAT4
danf00e9022013-08-14 19:54:12 +0000687*/
688static void statPush(
689 sqlite3_context *context,
690 int argc,
691 sqlite3_value **argv
692){
693 int i;
694
695 /* The three function arguments */
696 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh9fecc542013-08-27 20:16:48 +0000697 int iChng = sqlite3_value_int(argv[1]);
danf00e9022013-08-14 19:54:12 +0000698
drh4f991892013-10-11 15:05:05 +0000699 UNUSED_PARAMETER( argc );
700 UNUSED_PARAMETER( context );
drhec9e55d2014-06-30 17:07:39 +0000701 assert( p->nCol>0 );
danf00e9022013-08-14 19:54:12 +0000702 assert( iChng<p->nCol );
703
drh9fecc542013-08-27 20:16:48 +0000704 if( p->nRow==0 ){
danb49d1042013-09-02 18:58:11 +0000705 /* This is the first call to this function. Do initialization. */
drh9fecc542013-08-27 20:16:48 +0000706 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
707 }else{
708 /* Second and subsequent calls get processed here */
danf00e9022013-08-14 19:54:12 +0000709 samplePushPrevious(p, iChng);
710
711 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
712 ** to the current row of the index. */
713 for(i=0; i<iChng; i++){
714 p->current.anEq[i]++;
715 }
716 for(i=iChng; i<p->nCol; i++){
717 p->current.anDLt[i]++;
drh175b8f02019-08-08 15:24:17 +0000718#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000719 p->current.anLt[i] += p->current.anEq[i];
drh9fecc542013-08-27 20:16:48 +0000720#endif
danf00e9022013-08-14 19:54:12 +0000721 p->current.anEq[i] = 1;
722 }
danf00e9022013-08-14 19:54:12 +0000723 }
drh9fecc542013-08-27 20:16:48 +0000724 p->nRow++;
drh175b8f02019-08-08 15:24:17 +0000725#ifdef SQLITE_ENABLE_STAT4
drhebe25af2013-11-02 18:46:04 +0000726 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
drhda475b82013-11-04 21:44:54 +0000727 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000728 }else{
drhda475b82013-11-04 21:44:54 +0000729 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
730 sqlite3_value_blob(argv[2]));
drhebe25af2013-11-02 18:46:04 +0000731 }
drh9fecc542013-08-27 20:16:48 +0000732 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
733#endif
danf00e9022013-08-14 19:54:12 +0000734
drh92707ac2013-08-17 18:57:15 +0000735#ifdef SQLITE_ENABLE_STAT4
736 {
danf00e9022013-08-14 19:54:12 +0000737 tRowcnt nLt = p->current.anLt[p->nCol-1];
738
739 /* Check if this is to be a periodic sample. If so, add it. */
740 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
741 p->current.isPSample = 1;
742 p->current.iCol = 0;
743 sampleInsert(p, &p->current, p->nCol-1);
744 p->current.isPSample = 0;
745 }
746
747 /* Update the aBest[] array. */
748 for(i=0; i<(p->nCol-1); i++){
749 p->current.iCol = i;
danb13af4c2013-09-03 14:43:12 +0000750 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
danf00e9022013-08-14 19:54:12 +0000751 sampleCopy(p, &p->aBest[i], &p->current);
752 }
753 }
754 }
drh92707ac2013-08-17 18:57:15 +0000755#endif
danf00e9022013-08-14 19:54:12 +0000756}
757static const FuncDef statPushFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000758 2+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000759 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000760 0, /* pUserData */
761 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000762 statPush, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000763 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000764 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000765 "stat_push", /* zName */
drh80738d92016-02-15 00:34:16 +0000766 {0}
drhade3add2011-08-13 00:58:05 +0000767};
768
danf00e9022013-08-14 19:54:12 +0000769#define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
770#define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
771#define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
772#define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
773#define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
774
drhade3add2011-08-13 00:58:05 +0000775/*
drh92707ac2013-08-17 18:57:15 +0000776** Implementation of the stat_get(P,J) SQL function. This routine is
drh553818a2014-07-23 18:36:55 +0000777** used to query statistical information that has been gathered into
778** the Stat4Accum object by prior calls to stat_push(). The P parameter
drhf8ede572014-09-01 23:06:44 +0000779** has type BLOB but it is really just a pointer to the Stat4Accum object.
drh553818a2014-07-23 18:36:55 +0000780** The content to returned is determined by the parameter J
drh92707ac2013-08-17 18:57:15 +0000781** which is one of the STAT_GET_xxxx values defined above.
drhade3add2011-08-13 00:58:05 +0000782**
drh35497fc2017-02-01 01:34:15 +0000783** The stat_get(P,J) function is not available to generic SQL. It is
784** inserted as part of a manually constructed bytecode program. (See
785** the callStatGet() routine below.) It is guaranteed that the P
786** parameter will always be a poiner to a Stat4Accum object, never a
787** NULL.
788**
drh175b8f02019-08-08 15:24:17 +0000789** If STAT4 is not enabled, then J is always
drh92707ac2013-08-17 18:57:15 +0000790** STAT_GET_STAT1 and is hence omitted and this routine becomes
791** a one-parameter function, stat_get(P), that always returns the
792** stat1 table entry information.
drhade3add2011-08-13 00:58:05 +0000793*/
danf00e9022013-08-14 19:54:12 +0000794static void statGet(
drhade3add2011-08-13 00:58:05 +0000795 sqlite3_context *context,
796 int argc,
797 sqlite3_value **argv
798){
danf52bb8d2013-08-03 20:24:58 +0000799 Stat4Accum *p = (Stat4Accum*)sqlite3_value_blob(argv[0]);
drh175b8f02019-08-08 15:24:17 +0000800#ifdef SQLITE_ENABLE_STAT4
801 /* STAT4 has a parameter on this routine. */
danf00e9022013-08-14 19:54:12 +0000802 int eCall = sqlite3_value_int(argv[1]);
drh92707ac2013-08-17 18:57:15 +0000803 assert( argc==2 );
danf00e9022013-08-14 19:54:12 +0000804 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
805 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
806 || eCall==STAT_GET_NDLT
807 );
drh92707ac2013-08-17 18:57:15 +0000808 if( eCall==STAT_GET_STAT1 )
809#else
810 assert( argc==1 );
811#endif
812 {
danf00e9022013-08-14 19:54:12 +0000813 /* Return the value to store in the "stat" column of the sqlite_stat1
814 ** table for this index.
815 **
816 ** The value is a string composed of a list of integers describing
817 ** the index. The first integer in the list is the total number of
818 ** entries in the index. There is one additional integer in the list
819 ** for each indexed column. This additional integer is an estimate of
820 ** the number of rows matched by a stabbing query on the index using
821 ** a key with the corresponding number of fields. In other words,
822 ** if the index is on columns (a,b) and the sqlite_stat1 value is
823 ** "100 10 2", then SQLite estimates that:
824 **
825 ** * the index contains 100 rows,
826 ** * "WHERE a=?" matches 10 rows, and
827 ** * "WHERE a=? AND b=?" matches 2 rows.
828 **
829 ** If D is the count of distinct values and K is the total number of
830 ** rows, then each estimate is computed as:
831 **
832 ** I = (K+D-1)/D
833 */
834 char *z;
835 int i;
836
drhec9e55d2014-06-30 17:07:39 +0000837 char *zRet = sqlite3MallocZero( (p->nKeyCol+1)*25 );
danf00e9022013-08-14 19:54:12 +0000838 if( zRet==0 ){
839 sqlite3_result_error_nomem(context);
840 return;
841 }
842
drh26586e72013-10-09 19:07:22 +0000843 sqlite3_snprintf(24, zRet, "%llu", (u64)p->nRow);
danf00e9022013-08-14 19:54:12 +0000844 z = zRet + sqlite3Strlen30(zRet);
drhec9e55d2014-06-30 17:07:39 +0000845 for(i=0; i<p->nKeyCol; i++){
drh26586e72013-10-09 19:07:22 +0000846 u64 nDistinct = p->current.anDLt[i] + 1;
847 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
848 sqlite3_snprintf(24, z, " %llu", iVal);
danf00e9022013-08-14 19:54:12 +0000849 z += sqlite3Strlen30(z);
850 assert( p->current.anEq[i] );
851 }
852 assert( z[0]=='\0' && z>zRet );
853
854 sqlite3_result_text(context, zRet, -1, sqlite3_free);
drh92707ac2013-08-17 18:57:15 +0000855 }
drh175b8f02019-08-08 15:24:17 +0000856#ifdef SQLITE_ENABLE_STAT4
drh92707ac2013-08-17 18:57:15 +0000857 else if( eCall==STAT_GET_ROWID ){
danf00e9022013-08-14 19:54:12 +0000858 if( p->iGet<0 ){
859 samplePushPrevious(p, 0);
860 p->iGet = 0;
861 }
862 if( p->iGet<p->nSample ){
drhebe25af2013-11-02 18:46:04 +0000863 Stat4Sample *pS = p->a + p->iGet;
864 if( pS->nRowid==0 ){
drhda475b82013-11-04 21:44:54 +0000865 sqlite3_result_int64(context, pS->u.iRowid);
drhebe25af2013-11-02 18:46:04 +0000866 }else{
drhda475b82013-11-04 21:44:54 +0000867 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
868 SQLITE_TRANSIENT);
drhebe25af2013-11-02 18:46:04 +0000869 }
danf00e9022013-08-14 19:54:12 +0000870 }
871 }else{
danf52bb8d2013-08-03 20:24:58 +0000872 tRowcnt *aCnt = 0;
danf00e9022013-08-14 19:54:12 +0000873
874 assert( p->iGet<p->nSample );
875 switch( eCall ){
876 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
877 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
878 default: {
879 aCnt = p->a[p->iGet].anDLt;
880 p->iGet++;
881 break;
882 }
danf52bb8d2013-08-03 20:24:58 +0000883 }
884
drh175b8f02019-08-08 15:24:17 +0000885 {
danf00e9022013-08-14 19:54:12 +0000886 char *zRet = sqlite3MallocZero(p->nCol * 25);
dan8ad169a2013-08-12 20:14:04 +0000887 if( zRet==0 ){
888 sqlite3_result_error_nomem(context);
889 }else{
890 int i;
891 char *z = zRet;
892 for(i=0; i<p->nCol; i++){
drh26586e72013-10-09 19:07:22 +0000893 sqlite3_snprintf(24, z, "%llu ", (u64)aCnt[i]);
dan8ad169a2013-08-12 20:14:04 +0000894 z += sqlite3Strlen30(z);
895 }
896 assert( z[0]=='\0' && z>zRet );
897 z[-1] = '\0';
898 sqlite3_result_text(context, zRet, -1, sqlite3_free);
danf52bb8d2013-08-03 20:24:58 +0000899 }
danf52bb8d2013-08-03 20:24:58 +0000900 }
drhade3add2011-08-13 00:58:05 +0000901 }
drh175b8f02019-08-08 15:24:17 +0000902#endif /* SQLITE_ENABLE_STAT4 */
drh4f991892013-10-11 15:05:05 +0000903#ifndef SQLITE_DEBUG
904 UNUSED_PARAMETER( argc );
905#endif
drhade3add2011-08-13 00:58:05 +0000906}
danf00e9022013-08-14 19:54:12 +0000907static const FuncDef statGetFuncdef = {
drh175b8f02019-08-08 15:24:17 +0000908 1+IsStat4, /* nArg */
drhd36e1042013-09-06 13:10:12 +0000909 SQLITE_UTF8, /* funcFlags */
danf00e9022013-08-14 19:54:12 +0000910 0, /* pUserData */
911 0, /* pNext */
drh2d801512016-01-14 22:19:58 +0000912 statGet, /* xSFunc */
danf00e9022013-08-14 19:54:12 +0000913 0, /* xFinalize */
dan980cf252018-06-10 07:42:35 +0000914 0, 0, /* xValue, xInverse */
danf00e9022013-08-14 19:54:12 +0000915 "stat_get", /* zName */
drh80738d92016-02-15 00:34:16 +0000916 {0}
drhade3add2011-08-13 00:58:05 +0000917};
drhade3add2011-08-13 00:58:05 +0000918
danf00e9022013-08-14 19:54:12 +0000919static void callStatGet(Vdbe *v, int regStat4, int iParam, int regOut){
920 assert( regOut!=regStat4 && regOut!=regStat4+1 );
drh175b8f02019-08-08 15:24:17 +0000921#ifdef SQLITE_ENABLE_STAT4
danf00e9022013-08-14 19:54:12 +0000922 sqlite3VdbeAddOp2(v, OP_Integer, iParam, regStat4+1);
drh4f991892013-10-11 15:05:05 +0000923#elif SQLITE_DEBUG
drh92707ac2013-08-17 18:57:15 +0000924 assert( iParam==STAT_GET_STAT1 );
drh4f991892013-10-11 15:05:05 +0000925#else
926 UNUSED_PARAMETER( iParam );
drh92707ac2013-08-17 18:57:15 +0000927#endif
drh9b34abe2016-01-16 15:12:35 +0000928 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4, regOut,
929 (char*)&statGetFuncdef, P4_FUNCDEF);
drh175b8f02019-08-08 15:24:17 +0000930 sqlite3VdbeChangeP5(v, 1 + IsStat4);
danf00e9022013-08-14 19:54:12 +0000931}
drhade3add2011-08-13 00:58:05 +0000932
933/*
drhff2d5ea2005-07-23 00:41:48 +0000934** Generate code to do an analysis of all indices associated with
935** a single table.
936*/
937static void analyzeOneTable(
938 Parse *pParse, /* Parser context */
939 Table *pTab, /* Table whose indices are to be analyzed */
drha071bc52011-03-31 02:03:28 +0000940 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
drhdfe88ec2008-11-03 20:55:06 +0000941 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
danc6129702013-08-05 19:04:07 +0000942 int iMem, /* Available memory locations begin here */
drh4a54bb52017-02-18 15:58:52 +0000943 int iTab /* Next available cursor */
drhff2d5ea2005-07-23 00:41:48 +0000944){
dan0f9a34e2009-08-19 16:34:31 +0000945 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000946 Index *pIdx; /* An index to being analyzed */
947 int iIdxCur; /* Cursor open on index being analyzed */
danc6129702013-08-05 19:04:07 +0000948 int iTabCur; /* Table cursor */
dan69188d92009-08-19 08:18:32 +0000949 Vdbe *v; /* The virtual machine being built up */
950 int i; /* Loop counter */
drhf6cf1ff2011-03-30 14:54:05 +0000951 int jZeroRows = -1; /* Jump from here if number of rows is zero */
dan69188d92009-08-19 08:18:32 +0000952 int iDb; /* Index of database containing pTab */
drh721dfcf2013-08-01 04:39:17 +0000953 u8 needTableCnt = 1; /* True to count the table */
danf00e9022013-08-14 19:54:12 +0000954 int regNewRowid = iMem++; /* Rowid for the inserted record */
955 int regStat4 = iMem++; /* Register to hold Stat4Accum object */
danf00e9022013-08-14 19:54:12 +0000956 int regChng = iMem++; /* Index of changed index field */
drh175b8f02019-08-08 15:24:17 +0000957#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +0000958 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
959#endif
danf00e9022013-08-14 19:54:12 +0000960 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +0000961 int regTabname = iMem++; /* Register containing table name */
962 int regIdxname = iMem++; /* Register containing index name */
danf00e9022013-08-14 19:54:12 +0000963 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
964 int regPrev = iMem; /* MUST BE LAST (see below) */
dan614efe22018-01-12 16:44:29 +0000965#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
966 Table *pStat1 = 0;
967#endif
dan68c4dbb2009-08-20 09:11:06 +0000968
drhf0459fc2013-08-15 16:15:00 +0000969 pParse->nMem = MAX(pParse->nMem, iMem);
drhff2d5ea2005-07-23 00:41:48 +0000970 v = sqlite3GetVdbe(pParse);
drh15564052010-09-25 22:32:56 +0000971 if( v==0 || NEVER(pTab==0) ){
972 return;
973 }
drhf39d29c2010-09-28 17:34:46 +0000974 if( pTab->tnum==0 ){
975 /* Do not gather statistics on views or virtual tables */
drh15564052010-09-25 22:32:56 +0000976 return;
977 }
drhcedfecf2018-03-23 12:59:10 +0000978 if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
drh15564052010-09-25 22:32:56 +0000979 /* Do not gather statistics on system tables */
drhff2d5ea2005-07-23 00:41:48 +0000980 return;
981 }
dan0f9a34e2009-08-19 16:34:31 +0000982 assert( sqlite3BtreeHoldsAllMutexes(db) );
983 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +0000984 assert( iDb>=0 );
drh21206082011-04-04 18:22:02 +0000985 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drhe6e04962005-07-23 02:17:03 +0000986#ifndef SQLITE_OMIT_AUTHORIZATION
987 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
drh69c33822016-08-18 14:33:11 +0000988 db->aDb[iDb].zDbSName ) ){
drhe6e04962005-07-23 02:17:03 +0000989 return;
990 }
991#endif
992
dan614efe22018-01-12 16:44:29 +0000993#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
994 if( db->xPreUpdateCallback ){
995 pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
996 if( pStat1==0 ) return;
997 pStat1->zName = (char*)&pStat1[1];
998 memcpy(pStat1->zName, "sqlite_stat1", 13);
999 pStat1->nCol = 3;
1000 pStat1->iPKey = -1;
1001 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNBLOB);
1002 }
1003#endif
1004
dane0432012013-08-05 18:00:56 +00001005 /* Establish a read-lock on the table at the shared-cache level.
danf00e9022013-08-14 19:54:12 +00001006 ** Open a read-only cursor on the table. Also allocate a cursor number
1007 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1008 ** this time though. */
danielk1977c00da102006-01-07 13:21:04 +00001009 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
danc6129702013-08-05 19:04:07 +00001010 iTabCur = iTab++;
danf00e9022013-08-14 19:54:12 +00001011 iIdxCur = iTab++;
danc6129702013-08-05 19:04:07 +00001012 pParse->nTab = MAX(pParse->nTab, iTab);
dane0432012013-08-05 18:00:56 +00001013 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
drh076e85f2015-09-03 13:46:12 +00001014 sqlite3VdbeLoadString(v, regTabname, pTab->zName);
dane0432012013-08-05 18:00:56 +00001015
drhff2d5ea2005-07-23 00:41:48 +00001016 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh553818a2014-07-23 18:36:55 +00001017 int nCol; /* Number of columns in pIdx. "N" */
danf00e9022013-08-14 19:54:12 +00001018 int addrRewind; /* Address of "OP_Rewind iIdxCur" */
danf00e9022013-08-14 19:54:12 +00001019 int addrNextRow; /* Address of "next_row:" */
drhce95d112013-11-02 19:34:38 +00001020 const char *zIdxName; /* Name of the index */
drh553818a2014-07-23 18:36:55 +00001021 int nColTest; /* Number of columns to test for changes */
danielk1977b3bf5562006-01-10 17:58:23 +00001022
drha071bc52011-03-31 02:03:28 +00001023 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
drh721dfcf2013-08-01 04:39:17 +00001024 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
drhec9e55d2014-06-30 17:07:39 +00001025 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1026 nCol = pIdx->nKeyCol;
1027 zIdxName = pTab->zName;
drh553818a2014-07-23 18:36:55 +00001028 nColTest = nCol - 1;
drhec9e55d2014-06-30 17:07:39 +00001029 }else{
1030 nCol = pIdx->nColumn;
1031 zIdxName = pIdx->zName;
drh6861b8a2014-07-23 19:37:21 +00001032 nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
drhec9e55d2014-06-30 17:07:39 +00001033 }
dane275dc32009-08-18 16:24:58 +00001034
drh15564052010-09-25 22:32:56 +00001035 /* Populate the register containing the index name. */
drh076e85f2015-09-03 13:46:12 +00001036 sqlite3VdbeLoadString(v, regIdxname, zIdxName);
drhec9e55d2014-06-30 17:07:39 +00001037 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
dan69188d92009-08-19 08:18:32 +00001038
dane0432012013-08-05 18:00:56 +00001039 /*
danf00e9022013-08-14 19:54:12 +00001040 ** Pseudo-code for loop that calls stat_push():
dane0432012013-08-05 18:00:56 +00001041 **
danf00e9022013-08-14 19:54:12 +00001042 ** Rewind csr
1043 ** if eof(csr) goto end_of_scan;
1044 ** regChng = 0
1045 ** goto chng_addr_0;
dane0432012013-08-05 18:00:56 +00001046 **
dandd6e1f12013-08-10 19:08:30 +00001047 ** next_row:
danf00e9022013-08-14 19:54:12 +00001048 ** regChng = 0
1049 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1050 ** regChng = 1
1051 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1052 ** ...
1053 ** regChng = N
1054 ** goto chng_addr_N
dane0432012013-08-05 18:00:56 +00001055 **
danf00e9022013-08-14 19:54:12 +00001056 ** chng_addr_0:
1057 ** regPrev(0) = idx(0)
1058 ** chng_addr_1:
1059 ** regPrev(1) = idx(1)
1060 ** ...
dane0432012013-08-05 18:00:56 +00001061 **
drh9d793322014-07-24 19:54:20 +00001062 ** endDistinctTest:
danf00e9022013-08-14 19:54:12 +00001063 ** regRowid = idx(rowid)
drh9fecc542013-08-27 20:16:48 +00001064 ** stat_push(P, regChng, regRowid)
danf00e9022013-08-14 19:54:12 +00001065 ** Next csr
1066 ** if !eof(csr) goto next_row;
dane0432012013-08-05 18:00:56 +00001067 **
danf00e9022013-08-14 19:54:12 +00001068 ** end_of_scan:
dane0432012013-08-05 18:00:56 +00001069 */
danf00e9022013-08-14 19:54:12 +00001070
1071 /* Make sure there are enough memory cells allocated to accommodate
1072 ** the regPrev array and a trailing rowid (the rowid slot is required
1073 ** when building a record to insert into the sample column of
1074 ** the sqlite_stat4 table. */
drh553818a2014-07-23 18:36:55 +00001075 pParse->nMem = MAX(pParse->nMem, regPrev+nColTest);
dan02fa4692009-08-17 17:06:58 +00001076
danf00e9022013-08-14 19:54:12 +00001077 /* Open a read-only cursor on the index being analyzed. */
dane0432012013-08-05 18:00:56 +00001078 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danf00e9022013-08-14 19:54:12 +00001079 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
drh2ec2fb22013-11-06 19:59:23 +00001080 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
danf00e9022013-08-14 19:54:12 +00001081 VdbeComment((v, "%s", pIdx->zName));
dane0432012013-08-05 18:00:56 +00001082
danf00e9022013-08-14 19:54:12 +00001083 /* Invoke the stat_init() function. The arguments are:
danf52bb8d2013-08-03 20:24:58 +00001084 **
drh553818a2014-07-23 18:36:55 +00001085 ** (1) the number of columns in the index including the rowid
1086 ** (or for a WITHOUT ROWID table, the number of PK columns),
1087 ** (2) the number of columns in the key without the rowid/pk
1088 ** (3) the number of rows in the index,
drh9fecc542013-08-27 20:16:48 +00001089 **
drh553818a2014-07-23 18:36:55 +00001090 **
drh175b8f02019-08-08 15:24:17 +00001091 ** The third argument is only used for STAT4
danf52bb8d2013-08-03 20:24:58 +00001092 */
drh175b8f02019-08-08 15:24:17 +00001093#ifdef SQLITE_ENABLE_STAT4
drhec9e55d2014-06-30 17:07:39 +00001094 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regStat4+3);
drh9fecc542013-08-27 20:16:48 +00001095#endif
drhec9e55d2014-06-30 17:07:39 +00001096 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat4+1);
1097 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regStat4+2);
drh9b34abe2016-01-16 15:12:35 +00001098 sqlite3VdbeAddOp4(v, OP_Function0, 0, regStat4+1, regStat4,
1099 (char*)&statInitFuncdef, P4_FUNCDEF);
drh175b8f02019-08-08 15:24:17 +00001100 sqlite3VdbeChangeP5(v, 2+IsStat4);
danf52bb8d2013-08-03 20:24:58 +00001101
danf00e9022013-08-14 19:54:12 +00001102 /* Implementation of the following:
1103 **
1104 ** Rewind csr
1105 ** if eof(csr) goto end_of_scan;
1106 ** regChng = 0
1107 ** goto next_push_0;
1108 **
dandd6e1f12013-08-10 19:08:30 +00001109 */
danf00e9022013-08-14 19:54:12 +00001110 addrRewind = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
drh688852a2014-02-17 22:40:43 +00001111 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001112 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
danf00e9022013-08-14 19:54:12 +00001113 addrNextRow = sqlite3VdbeCurrentAddr(v);
dane0432012013-08-05 18:00:56 +00001114
drh553818a2014-07-23 18:36:55 +00001115 if( nColTest>0 ){
drhec4ccdb2018-12-29 02:26:59 +00001116 int endDistinctTest = sqlite3VdbeMakeLabel(pParse);
drhb12879f2014-07-24 20:25:16 +00001117 int *aGotoChng; /* Array of jump instruction addresses */
drh575fad62016-02-05 13:38:36 +00001118 aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
drhb12879f2014-07-24 20:25:16 +00001119 if( aGotoChng==0 ) continue;
danf00e9022013-08-14 19:54:12 +00001120
drh553818a2014-07-23 18:36:55 +00001121 /*
1122 ** next_row:
1123 ** regChng = 0
1124 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1125 ** regChng = 1
1126 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1127 ** ...
1128 ** regChng = N
drh9d793322014-07-24 19:54:20 +00001129 ** goto endDistinctTest
drh553818a2014-07-23 18:36:55 +00001130 */
1131 sqlite3VdbeAddOp0(v, OP_Goto);
1132 addrNextRow = sqlite3VdbeCurrentAddr(v);
drh5f1d1d92014-07-31 22:59:04 +00001133 if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
drh9d793322014-07-24 19:54:20 +00001134 /* For a single-column UNIQUE index, once we have found a non-NULL
1135 ** row, we know that all the rest will be distinct, so skip
1136 ** subsequent distinctness tests. */
1137 sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1138 VdbeCoverage(v);
1139 }
drh553818a2014-07-23 18:36:55 +00001140 for(i=0; i<nColTest; i++){
1141 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1142 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1143 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1144 aGotoChng[i] =
1145 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1146 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1147 VdbeCoverage(v);
1148 }
1149 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
drh076e85f2015-09-03 13:46:12 +00001150 sqlite3VdbeGoto(v, endDistinctTest);
drh553818a2014-07-23 18:36:55 +00001151
1152
1153 /*
1154 ** chng_addr_0:
1155 ** regPrev(0) = idx(0)
1156 ** chng_addr_1:
1157 ** regPrev(1) = idx(1)
1158 ** ...
1159 */
1160 sqlite3VdbeJumpHere(v, addrNextRow-1);
1161 for(i=0; i<nColTest; i++){
1162 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1163 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1164 }
drh9d793322014-07-24 19:54:20 +00001165 sqlite3VdbeResolveLabel(v, endDistinctTest);
drhb12879f2014-07-24 20:25:16 +00001166 sqlite3DbFree(db, aGotoChng);
drhff2d5ea2005-07-23 00:41:48 +00001167 }
drh553818a2014-07-23 18:36:55 +00001168
danf00e9022013-08-14 19:54:12 +00001169 /*
1170 ** chng_addr_N:
drh175b8f02019-08-08 15:24:17 +00001171 ** regRowid = idx(rowid) // STAT4 only
1172 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT4 only
danf00e9022013-08-14 19:54:12 +00001173 ** Next csr
1174 ** if !eof(csr) goto next_row;
1175 */
drh175b8f02019-08-08 15:24:17 +00001176#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +00001177 assert( regRowid==(regStat4+2) );
drhebe25af2013-11-02 18:46:04 +00001178 if( HasRowid(pTab) ){
1179 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1180 }else{
1181 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1182 int j, k, regKey;
1183 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1184 for(j=0; j<pPk->nKeyCol; j++){
drhb9bcf7c2019-10-19 13:29:10 +00001185 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
drh49297c82017-03-21 18:56:52 +00001186 assert( k>=0 && k<pIdx->nColumn );
drhebe25af2013-11-02 18:46:04 +00001187 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1188 VdbeComment((v, "%s", pTab->aCol[pPk->aiColumn[j]].zName));
1189 }
1190 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1191 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1192 }
drh9fecc542013-08-27 20:16:48 +00001193#endif
1194 assert( regChng==(regStat4+1) );
drh9b34abe2016-01-16 15:12:35 +00001195 sqlite3VdbeAddOp4(v, OP_Function0, 1, regStat4, regTemp,
1196 (char*)&statPushFuncdef, P4_FUNCDEF);
drh175b8f02019-08-08 15:24:17 +00001197 sqlite3VdbeChangeP5(v, 2+IsStat4);
drh688852a2014-02-17 22:40:43 +00001198 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001199
1200 /* Add the entry to the stat1 table. */
1201 callStatGet(v, regStat4, STAT_GET_STAT1, regStat1);
drh4583c372014-09-19 20:13:25 +00001202 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1203 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drhade3add2011-08-13 00:58:05 +00001204 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001205 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
dan614efe22018-01-12 16:44:29 +00001206#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1207 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1208#endif
drh2d401ab2008-01-10 23:50:11 +00001209 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
danf00e9022013-08-14 19:54:12 +00001210
drh175b8f02019-08-08 15:24:17 +00001211 /* Add the entries to the stat4 table. */
1212#ifdef SQLITE_ENABLE_STAT4
drh9fecc542013-08-27 20:16:48 +00001213 {
danf00e9022013-08-14 19:54:12 +00001214 int regEq = regStat1;
1215 int regLt = regStat1+1;
1216 int regDLt = regStat1+2;
1217 int regSample = regStat1+3;
1218 int regCol = regStat1+4;
1219 int regSampleRowid = regCol + nCol;
1220 int addrNext;
1221 int addrIsNull;
drhebe25af2013-11-02 18:46:04 +00001222 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
danf00e9022013-08-14 19:54:12 +00001223
drhec9e55d2014-06-30 17:07:39 +00001224 pParse->nMem = MAX(pParse->nMem, regCol+nCol);
danf00e9022013-08-14 19:54:12 +00001225
1226 addrNext = sqlite3VdbeCurrentAddr(v);
1227 callStatGet(v, regStat4, STAT_GET_ROWID, regSampleRowid);
1228 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
drh688852a2014-02-17 22:40:43 +00001229 VdbeCoverage(v);
danf00e9022013-08-14 19:54:12 +00001230 callStatGet(v, regStat4, STAT_GET_NEQ, regEq);
1231 callStatGet(v, regStat4, STAT_GET_NLT, regLt);
1232 callStatGet(v, regStat4, STAT_GET_NDLT, regDLt);
drhebe25af2013-11-02 18:46:04 +00001233 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
drh6ccbd272018-07-10 17:10:44 +00001234 VdbeCoverage(v);
drhec9e55d2014-06-30 17:07:39 +00001235 for(i=0; i<nCol; i++){
drh1f9ca2c2015-08-25 16:57:52 +00001236 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
danf00e9022013-08-14 19:54:12 +00001237 }
drhec9e55d2014-06-30 17:07:39 +00001238 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
drh57bf4a82014-02-17 14:59:22 +00001239 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
danf00e9022013-08-14 19:54:12 +00001240 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1241 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
drhfe705102014-03-06 13:38:37 +00001242 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
danf00e9022013-08-14 19:54:12 +00001243 sqlite3VdbeJumpHere(v, addrIsNull);
1244 }
drh175b8f02019-08-08 15:24:17 +00001245#endif /* SQLITE_ENABLE_STAT4 */
danf00e9022013-08-14 19:54:12 +00001246
drh9fecc542013-08-27 20:16:48 +00001247 /* End of analysis */
danf00e9022013-08-14 19:54:12 +00001248 sqlite3VdbeJumpHere(v, addrRewind);
drh15564052010-09-25 22:32:56 +00001249 }
1250
danf00e9022013-08-14 19:54:12 +00001251
drh721dfcf2013-08-01 04:39:17 +00001252 /* Create a single sqlite_stat1 entry containing NULL as the index
1253 ** name and the row count as the content.
drh15564052010-09-25 22:32:56 +00001254 */
drh721dfcf2013-08-01 04:39:17 +00001255 if( pOnlyIdx==0 && needTableCnt ){
drh15564052010-09-25 22:32:56 +00001256 VdbeComment((v, "%s", pTab->zName));
dane0432012013-08-05 18:00:56 +00001257 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
drh688852a2014-02-17 22:40:43 +00001258 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
drh721dfcf2013-08-01 04:39:17 +00001259 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
drh4583c372014-09-19 20:13:25 +00001260 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1261 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
drh721dfcf2013-08-01 04:39:17 +00001262 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
danf00e9022013-08-14 19:54:12 +00001263 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
drh721dfcf2013-08-01 04:39:17 +00001264 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
dan3739f292018-01-17 20:57:20 +00001265#ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1266 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1267#endif
drh15564052010-09-25 22:32:56 +00001268 sqlite3VdbeJumpHere(v, jZeroRows);
1269 }
drhff2d5ea2005-07-23 00:41:48 +00001270}
1271
drh72052a72017-02-17 16:26:34 +00001272
1273/*
drh4a54bb52017-02-18 15:58:52 +00001274** Generate code that will cause the most recent index analysis to
1275** be loaded into internal hash tables where is can be used.
drh72052a72017-02-17 16:26:34 +00001276*/
drh4a54bb52017-02-18 15:58:52 +00001277static void loadAnalysis(Parse *pParse, int iDb){
drh182e84c2017-02-18 02:19:02 +00001278 Vdbe *v = sqlite3GetVdbe(pParse);
drh4a54bb52017-02-18 15:58:52 +00001279 if( v ){
1280 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1281 }
1282}
drhff2d5ea2005-07-23 00:41:48 +00001283
drh4a54bb52017-02-18 15:58:52 +00001284/*
1285** Generate code that will do an analysis of an entire database
1286*/
1287static void analyzeDatabase(Parse *pParse, int iDb){
1288 sqlite3 *db = pParse->db;
1289 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
1290 HashElem *k;
1291 int iStatCur;
1292 int iMem;
1293 int iTab;
1294
1295 sqlite3BeginWriteOperation(pParse, 0, iDb);
1296 iStatCur = pParse->nTab;
1297 pParse->nTab += 3;
1298 openStatTable(pParse, iDb, iStatCur, 0, 0);
1299 iMem = pParse->nMem+1;
1300 iTab = pParse->nTab;
1301 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1302 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1303 Table *pTab = (Table*)sqliteHashData(k);
1304 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
drhff2d5ea2005-07-23 00:41:48 +00001305 }
drh4a54bb52017-02-18 15:58:52 +00001306 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001307}
1308
1309/*
1310** Generate code that will do an analysis of a single table in
drha071bc52011-03-31 02:03:28 +00001311** a database. If pOnlyIdx is not NULL then it is a single index
1312** in pTab that should be analyzed.
drhff2d5ea2005-07-23 00:41:48 +00001313*/
drha071bc52011-03-31 02:03:28 +00001314static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
drhff2d5ea2005-07-23 00:41:48 +00001315 int iDb;
1316 int iStatCur;
1317
1318 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +00001319 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +00001320 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +00001321 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +00001322 iStatCur = pParse->nTab;
drhade3add2011-08-13 00:58:05 +00001323 pParse->nTab += 3;
drha071bc52011-03-31 02:03:28 +00001324 if( pOnlyIdx ){
1325 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1326 }else{
1327 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1328 }
drh4a54bb52017-02-18 15:58:52 +00001329 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1330 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001331}
1332
1333/*
1334** Generate code for the ANALYZE command. The parser calls this routine
1335** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +00001336**
1337** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +00001338** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +00001339** ANALYZE ?<database>.?<tablename> -- 3
1340**
1341** Form 1 causes all indices in all attached databases to be analyzed.
1342** Form 2 analyzes all indices the single database named.
1343** Form 3 analyzes all indices associated with the named table.
1344*/
drh182e84c2017-02-18 02:19:02 +00001345void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +00001346 sqlite3 *db = pParse->db;
1347 int iDb;
drh4a54bb52017-02-18 15:58:52 +00001348 int i;
drhff2d5ea2005-07-23 00:41:48 +00001349 char *z, *zDb;
1350 Table *pTab;
drha071bc52011-03-31 02:03:28 +00001351 Index *pIdx;
drhff2d5ea2005-07-23 00:41:48 +00001352 Token *pTableName;
drh4a54bb52017-02-18 15:58:52 +00001353 Vdbe *v;
drhff2d5ea2005-07-23 00:41:48 +00001354
1355 /* Read the database schema. If an error occurs, leave an error message
1356 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +00001357 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +00001358 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1359 return;
1360 }
1361
drh05800a12009-04-16 17:45:47 +00001362 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +00001363 if( pName1==0 ){
1364 /* Form 1: Analyze everything */
drh4a54bb52017-02-18 15:58:52 +00001365 for(i=0; i<db->nDb; i++){
1366 if( i==1 ) continue; /* Do not analyze the TEMP database */
1367 analyzeDatabase(pParse, i);
1368 }
drhbce04142017-02-23 00:58:36 +00001369 }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1370 /* Analyze the schema named as the argument */
1371 analyzeDatabase(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +00001372 }else{
drhbce04142017-02-23 00:58:36 +00001373 /* Form 3: Analyze the table or index named as an argument */
drhff2d5ea2005-07-23 00:41:48 +00001374 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1375 if( iDb>=0 ){
drhbce04142017-02-23 00:58:36 +00001376 zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
drh17435752007-08-16 04:30:38 +00001377 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +00001378 if( z ){
drha071bc52011-03-31 02:03:28 +00001379 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1380 analyzeTable(pParse, pIdx->pTable, pIdx);
1381 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1382 analyzeTable(pParse, pTab, 0);
drhcf1be452007-05-12 12:08:51 +00001383 }
drha071bc52011-03-31 02:03:28 +00001384 sqlite3DbFree(db, z);
drhff2d5ea2005-07-23 00:41:48 +00001385 }
drhbce04142017-02-23 00:58:36 +00001386 }
drhff2d5ea2005-07-23 00:41:48 +00001387 }
drhbce04142017-02-23 00:58:36 +00001388 if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1389 sqlite3VdbeAddOp0(v, OP_Expire);
1390 }
drh9f18e8a2005-07-08 12:13:04 +00001391}
1392
drh497e4462005-07-23 03:18:40 +00001393/*
1394** Used to pass information from the analyzer reader through to the
1395** callback routine.
1396*/
1397typedef struct analysisInfo analysisInfo;
1398struct analysisInfo {
1399 sqlite3 *db;
1400 const char *zDatabase;
1401};
1402
1403/*
danf52bb8d2013-08-03 20:24:58 +00001404** The first argument points to a nul-terminated string containing a
1405** list of space separated integers. Read the first nOut of these into
1406** the array aOut[].
1407*/
1408static void decodeIntArray(
drhc28c4e52013-10-03 19:21:41 +00001409 char *zIntArray, /* String containing int array to decode */
1410 int nOut, /* Number of slots in aOut[] */
1411 tRowcnt *aOut, /* Store integers here */
dancfc9df72014-04-25 15:01:01 +00001412 LogEst *aLog, /* Or, if aOut==0, here */
drhc28c4e52013-10-03 19:21:41 +00001413 Index *pIndex /* Handle extra flags for this index, if not NULL */
danf52bb8d2013-08-03 20:24:58 +00001414){
1415 char *z = zIntArray;
1416 int c;
1417 int i;
1418 tRowcnt v;
drh1435a9a2013-08-27 23:15:44 +00001419
drh175b8f02019-08-08 15:24:17 +00001420#ifdef SQLITE_ENABLE_STAT4
drh6d57bbf2013-08-28 11:43:49 +00001421 if( z==0 ) z = "";
1422#else
drh85d117b2014-10-06 18:33:49 +00001423 assert( z!=0 );
drh6d57bbf2013-08-28 11:43:49 +00001424#endif
danf52bb8d2013-08-03 20:24:58 +00001425 for(i=0; *z && i<nOut; i++){
1426 v = 0;
1427 while( (c=z[0])>='0' && c<='9' ){
1428 v = v*10 + c - '0';
1429 z++;
1430 }
drh175b8f02019-08-08 15:24:17 +00001431#ifdef SQLITE_ENABLE_STAT4
drh85d117b2014-10-06 18:33:49 +00001432 if( aOut ) aOut[i] = v;
1433 if( aLog ) aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001434#else
1435 assert( aOut==0 );
1436 UNUSED_PARAMETER(aOut);
drh85d117b2014-10-06 18:33:49 +00001437 assert( aLog!=0 );
1438 aLog[i] = sqlite3LogEst(v);
drhc5f246e2014-05-01 20:24:21 +00001439#endif
danf52bb8d2013-08-03 20:24:58 +00001440 if( *z==' ' ) z++;
1441 }
drh175b8f02019-08-08 15:24:17 +00001442#ifndef SQLITE_ENABLE_STAT4
drh0da10d322014-11-22 21:37:00 +00001443 assert( pIndex!=0 ); {
drh1f1fc0c2013-10-08 23:16:48 +00001444#else
drh0da10d322014-11-22 21:37:00 +00001445 if( pIndex ){
drh1f1fc0c2013-10-08 23:16:48 +00001446#endif
drh0da10d322014-11-22 21:37:00 +00001447 pIndex->bUnordered = 0;
1448 pIndex->noSkipScan = 0;
1449 while( z[0] ){
1450 if( sqlite3_strglob("unordered*", z)==0 ){
1451 pIndex->bUnordered = 1;
1452 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
drh725dd722019-08-15 14:35:45 +00001453 int sz = sqlite3Atoi(z+3);
1454 if( sz<2 ) sz = 2;
1455 pIndex->szIdxRow = sqlite3LogEst(sz);
drh0da10d322014-11-22 21:37:00 +00001456 }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1457 pIndex->noSkipScan = 1;
1458 }
drhdbd94862014-07-23 23:57:42 +00001459#ifdef SQLITE_ENABLE_COSTMULT
drh0da10d322014-11-22 21:37:00 +00001460 else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1461 pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1462 }
drhdbd94862014-07-23 23:57:42 +00001463#endif
drh0da10d322014-11-22 21:37:00 +00001464 while( z[0]!=0 && z[0]!=' ' ) z++;
1465 while( z[0]==' ' ) z++;
1466 }
danf52bb8d2013-08-03 20:24:58 +00001467 }
1468}
1469
1470/*
drh497e4462005-07-23 03:18:40 +00001471** This callback is invoked once for each index when reading the
1472** sqlite_stat1 table.
1473**
drh15564052010-09-25 22:32:56 +00001474** argv[0] = name of the table
1475** argv[1] = name of the index (might be NULL)
1476** argv[2] = results of analysis - on integer for each column
1477**
1478** Entries for which argv[1]==NULL simply record the number of rows in
1479** the table.
drh497e4462005-07-23 03:18:40 +00001480*/
danielk197762c14b32008-11-19 09:05:26 +00001481static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +00001482 analysisInfo *pInfo = (analysisInfo*)pData;
1483 Index *pIndex;
drh15564052010-09-25 22:32:56 +00001484 Table *pTable;
drh497e4462005-07-23 03:18:40 +00001485 const char *z;
1486
drh15564052010-09-25 22:32:56 +00001487 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +00001488 UNUSED_PARAMETER2(NotUsed, argc);
1489
drh15564052010-09-25 22:32:56 +00001490 if( argv==0 || argv[0]==0 || argv[2]==0 ){
drh497e4462005-07-23 03:18:40 +00001491 return 0;
1492 }
drh15564052010-09-25 22:32:56 +00001493 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1494 if( pTable==0 ){
drh497e4462005-07-23 03:18:40 +00001495 return 0;
1496 }
drhc2b23e72013-11-13 15:32:15 +00001497 if( argv[1]==0 ){
drh15564052010-09-25 22:32:56 +00001498 pIndex = 0;
drhc2b23e72013-11-13 15:32:15 +00001499 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1500 pIndex = sqlite3PrimaryKeyIndex(pTable);
1501 }else{
1502 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
drh15564052010-09-25 22:32:56 +00001503 }
drh15564052010-09-25 22:32:56 +00001504 z = argv[2];
danf52bb8d2013-08-03 20:24:58 +00001505
1506 if( pIndex ){
dan4eed0532015-04-20 15:13:08 +00001507 tRowcnt *aiRowEst = 0;
dan43085d72014-10-03 19:16:53 +00001508 int nCol = pIndex->nKeyCol+1;
drh175b8f02019-08-08 15:24:17 +00001509#ifdef SQLITE_ENABLE_STAT4
dan4eed0532015-04-20 15:13:08 +00001510 /* Index.aiRowEst may already be set here if there are duplicate
1511 ** sqlite_stat1 entries for this index. In that case just clobber
1512 ** the old data with the new instead of allocating a new array. */
1513 if( pIndex->aiRowEst==0 ){
1514 pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
drh4a642b62016-02-05 01:55:27 +00001515 if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
dan4eed0532015-04-20 15:13:08 +00001516 }
1517 aiRowEst = pIndex->aiRowEst;
dan43085d72014-10-03 19:16:53 +00001518#endif
drh25df48d2014-07-22 14:58:12 +00001519 pIndex->bUnordered = 0;
dan43085d72014-10-03 19:16:53 +00001520 decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
drh33bec3f2017-02-17 13:38:15 +00001521 pIndex->hasStat1 = 1;
1522 if( pIndex->pPartIdxWhere==0 ){
1523 pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1524 pTable->tabFlags |= TF_HasStat1;
1525 }
danf52bb8d2013-08-03 20:24:58 +00001526 }else{
drh52f6c912013-10-06 22:12:41 +00001527 Index fakeIdx;
1528 fakeIdx.szIdxRow = pTable->szTabRow;
drhdbd94862014-07-23 23:57:42 +00001529#ifdef SQLITE_ENABLE_COSTMULT
1530 fakeIdx.pTable = pTable;
1531#endif
dancfc9df72014-04-25 15:01:01 +00001532 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
drh52f6c912013-10-06 22:12:41 +00001533 pTable->szTabRow = fakeIdx.szIdxRow;
drh33bec3f2017-02-17 13:38:15 +00001534 pTable->tabFlags |= TF_HasStat1;
drh497e4462005-07-23 03:18:40 +00001535 }
danf52bb8d2013-08-03 20:24:58 +00001536
drh497e4462005-07-23 03:18:40 +00001537 return 0;
1538}
1539
1540/*
dan85c165c2009-08-19 14:34:54 +00001541** If the Index.aSample variable is not NULL, delete the aSample[] array
1542** and its contents.
1543*/
dand46def72010-07-24 11:28:28 +00001544void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
drh175b8f02019-08-08 15:24:17 +00001545#ifdef SQLITE_ENABLE_STAT4
dan85c165c2009-08-19 14:34:54 +00001546 if( pIdx->aSample ){
1547 int j;
drhfaacf172011-08-12 01:51:45 +00001548 for(j=0; j<pIdx->nSample; j++){
dan85c165c2009-08-19 14:34:54 +00001549 IndexSample *p = &pIdx->aSample[j];
danf52bb8d2013-08-03 20:24:58 +00001550 sqlite3DbFree(db, p->p);
dan85c165c2009-08-19 14:34:54 +00001551 }
drh8e3937f2011-08-18 13:45:23 +00001552 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +00001553 }
drh8e3937f2011-08-18 13:45:23 +00001554 if( db && db->pnBytesFreed==0 ){
1555 pIdx->nSample = 0;
1556 pIdx->aSample = 0;
1557 }
shanecea72b22009-09-07 04:38:36 +00001558#else
drh43b18e12010-08-17 19:40:08 +00001559 UNUSED_PARAMETER(db);
shanecea72b22009-09-07 04:38:36 +00001560 UNUSED_PARAMETER(pIdx);
drh175b8f02019-08-08 15:24:17 +00001561#endif /* SQLITE_ENABLE_STAT4 */
dan85c165c2009-08-19 14:34:54 +00001562}
1563
drh175b8f02019-08-08 15:24:17 +00001564#ifdef SQLITE_ENABLE_STAT4
dan0adbed82013-08-15 19:56:32 +00001565/*
1566** Populate the pIdx->aAvgEq[] array based on the samples currently
1567** stored in pIdx->aSample[].
1568*/
1569static void initAvgEq(Index *pIdx){
1570 if( pIdx ){
1571 IndexSample *aSample = pIdx->aSample;
1572 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1573 int iCol;
dan39caccf2014-07-01 11:54:02 +00001574 int nCol = 1;
1575 if( pIdx->nSampleCol>1 ){
1576 /* If this is stat4 data, then calculate aAvgEq[] values for all
1577 ** sample columns except the last. The last is always set to 1, as
1578 ** once the trailing PK fields are considered all index keys are
1579 ** unique. */
1580 nCol = pIdx->nSampleCol-1;
1581 pIdx->aAvgEq[nCol] = 1;
1582 }
1583 for(iCol=0; iCol<nCol; iCol++){
dan43085d72014-10-03 19:16:53 +00001584 int nSample = pIdx->nSample;
dan0adbed82013-08-15 19:56:32 +00001585 int i; /* Used to iterate through samples */
1586 tRowcnt sumEq = 0; /* Sum of the nEq values */
dan0adbed82013-08-15 19:56:32 +00001587 tRowcnt avgEq = 0;
dan43085d72014-10-03 19:16:53 +00001588 tRowcnt nRow; /* Number of rows in index */
1589 i64 nSum100 = 0; /* Number of terms contributing to sumEq */
1590 i64 nDist100; /* Number of distinct values in index */
1591
dan5cca94e2014-12-05 21:04:26 +00001592 if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
dan43085d72014-10-03 19:16:53 +00001593 nRow = pFinal->anLt[iCol];
1594 nDist100 = (i64)100 * pFinal->anDLt[iCol];
1595 nSample--;
1596 }else{
1597 nRow = pIdx->aiRowEst[0];
1598 nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1599 }
drh9f07cf72014-10-22 15:27:05 +00001600 pIdx->nRowEst0 = nRow;
dan0adbed82013-08-15 19:56:32 +00001601
1602 /* Set nSum to the number of distinct (iCol+1) field prefixes that
dan43085d72014-10-03 19:16:53 +00001603 ** occur in the stat4 table for this index. Set sumEq to the sum of
1604 ** the nEq values for column iCol for the same set (adding the value
1605 ** only once where there exist duplicate prefixes). */
1606 for(i=0; i<nSample; i++){
1607 if( i==(pIdx->nSample-1)
1608 || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1609 ){
dan0adbed82013-08-15 19:56:32 +00001610 sumEq += aSample[i].anEq[iCol];
dan43085d72014-10-03 19:16:53 +00001611 nSum100 += 100;
dan0adbed82013-08-15 19:56:32 +00001612 }
1613 }
dan43085d72014-10-03 19:16:53 +00001614
drh785d8ed2017-01-11 14:15:29 +00001615 if( nDist100>nSum100 && sumEq<nRow ){
dan43085d72014-10-03 19:16:53 +00001616 avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
dan0adbed82013-08-15 19:56:32 +00001617 }
1618 if( avgEq==0 ) avgEq = 1;
1619 pIdx->aAvgEq[iCol] = avgEq;
dan0adbed82013-08-15 19:56:32 +00001620 }
1621 }
1622}
1623
dan0106e372013-08-12 16:34:32 +00001624/*
drhce95d112013-11-02 19:34:38 +00001625** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1626** is supplied instead, find the PRIMARY KEY index for that table.
1627*/
1628static Index *findIndexOrPrimaryKey(
1629 sqlite3 *db,
1630 const char *zName,
1631 const char *zDb
1632){
1633 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1634 if( pIdx==0 ){
1635 Table *pTab = sqlite3FindTable(db, zName, zDb);
1636 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1637 }
1638 return pIdx;
1639}
1640
1641/*
drh175b8f02019-08-08 15:24:17 +00001642** Load the content from either the sqlite_stat4
dan0106e372013-08-12 16:34:32 +00001643** into the relevant Index.aSample[] arrays.
1644**
1645** Arguments zSql1 and zSql2 must point to SQL statements that return
drh175b8f02019-08-08 15:24:17 +00001646** data equivalent to the following:
dan0106e372013-08-12 16:34:32 +00001647**
1648** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1649** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1650**
1651** where %Q is replaced with the database name before the SQL is executed.
1652*/
1653static int loadStatTbl(
1654 sqlite3 *db, /* Database handle */
dan0106e372013-08-12 16:34:32 +00001655 const char *zSql1, /* SQL statement 1 (see above) */
1656 const char *zSql2, /* SQL statement 2 (see above) */
1657 const char *zDb /* Database name (e.g. "main") */
1658){
drhfaacf172011-08-12 01:51:45 +00001659 int rc; /* Result codes from subroutines */
1660 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1661 char *zSql; /* Text of the SQL statement */
1662 Index *pPrevIdx = 0; /* Previous index in the loop */
drhfaacf172011-08-12 01:51:45 +00001663 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1664
drh4a642b62016-02-05 01:55:27 +00001665 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001666 zSql = sqlite3MPrintf(db, zSql1, zDb);
drhfaacf172011-08-12 01:51:45 +00001667 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001668 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001669 }
1670 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1671 sqlite3DbFree(db, zSql);
1672 if( rc ) return rc;
1673
1674 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001675 int nIdxCol = 1; /* Number of columns in stat4 records */
dan0106e372013-08-12 16:34:32 +00001676
drhfaacf172011-08-12 01:51:45 +00001677 char *zIndex; /* Index name */
1678 Index *pIdx; /* Pointer to the index object */
1679 int nSample; /* Number of samples */
danf52bb8d2013-08-03 20:24:58 +00001680 int nByte; /* Bytes of space required */
1681 int i; /* Bytes of space required */
1682 tRowcnt *pSpace;
drhfaacf172011-08-12 01:51:45 +00001683
1684 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1685 if( zIndex==0 ) continue;
1686 nSample = sqlite3_column_int(pStmt, 1);
drhce95d112013-11-02 19:34:38 +00001687 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drh175b8f02019-08-08 15:24:17 +00001688 assert( pIdx==0 || pIdx->nSample==0 );
drh5eae1d12019-08-08 16:23:12 +00001689 if( pIdx==0 ) continue;
drh175b8f02019-08-08 15:24:17 +00001690 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1691 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1692 nIdxCol = pIdx->nKeyCol;
1693 }else{
1694 nIdxCol = pIdx->nColumn;
dan0106e372013-08-12 16:34:32 +00001695 }
dan8ad169a2013-08-12 20:14:04 +00001696 pIdx->nSampleCol = nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001697 nByte = sizeof(IndexSample) * nSample;
dan0106e372013-08-12 16:34:32 +00001698 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
dan39caccf2014-07-01 11:54:02 +00001699 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
danf52bb8d2013-08-03 20:24:58 +00001700
1701 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
drhfaacf172011-08-12 01:51:45 +00001702 if( pIdx->aSample==0 ){
drhfaacf172011-08-12 01:51:45 +00001703 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001704 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001705 }
danf52bb8d2013-08-03 20:24:58 +00001706 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
dan39caccf2014-07-01 11:54:02 +00001707 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
dan0adbed82013-08-15 19:56:32 +00001708 for(i=0; i<nSample; i++){
dan0106e372013-08-12 16:34:32 +00001709 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1710 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1711 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
danf52bb8d2013-08-03 20:24:58 +00001712 }
1713 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
drhfaacf172011-08-12 01:51:45 +00001714 }
drh8e3937f2011-08-18 13:45:23 +00001715 rc = sqlite3_finalize(pStmt);
1716 if( rc ) return rc;
drhfaacf172011-08-12 01:51:45 +00001717
dan0106e372013-08-12 16:34:32 +00001718 zSql = sqlite3MPrintf(db, zSql2, zDb);
drhfaacf172011-08-12 01:51:45 +00001719 if( !zSql ){
mistachkinfad30392016-02-13 23:43:46 +00001720 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001721 }
1722 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1723 sqlite3DbFree(db, zSql);
1724 if( rc ) return rc;
1725
1726 while( sqlite3_step(pStmt)==SQLITE_ROW ){
dan0106e372013-08-12 16:34:32 +00001727 char *zIndex; /* Index name */
1728 Index *pIdx; /* Pointer to the index object */
dan0106e372013-08-12 16:34:32 +00001729 int nCol = 1; /* Number of columns in index */
drhfaacf172011-08-12 01:51:45 +00001730
1731 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1732 if( zIndex==0 ) continue;
drhce95d112013-11-02 19:34:38 +00001733 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
drhfaacf172011-08-12 01:51:45 +00001734 if( pIdx==0 ) continue;
dan86f69d92013-08-12 17:31:32 +00001735 /* This next condition is true if data has already been loaded from
drh175b8f02019-08-08 15:24:17 +00001736 ** the sqlite_stat4 table. */
dan0adbed82013-08-15 19:56:32 +00001737 nCol = pIdx->nSampleCol;
dan0adbed82013-08-15 19:56:32 +00001738 if( pIdx!=pPrevIdx ){
1739 initAvgEq(pPrevIdx);
1740 pPrevIdx = pIdx;
dan0106e372013-08-12 16:34:32 +00001741 }
danc367d4c2013-08-16 14:09:43 +00001742 pSample = &pIdx->aSample[pIdx->nSample];
dancfc9df72014-04-25 15:01:01 +00001743 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1744 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1745 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
danf52bb8d2013-08-03 20:24:58 +00001746
danc367d4c2013-08-16 14:09:43 +00001747 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1748 ** This is in case the sample record is corrupted. In that case, the
1749 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1750 ** end of the allocated buffer before it realizes it is dealing with
1751 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1752 ** a buffer overread. */
danf52bb8d2013-08-03 20:24:58 +00001753 pSample->n = sqlite3_column_bytes(pStmt, 4);
danc367d4c2013-08-16 14:09:43 +00001754 pSample->p = sqlite3DbMallocZero(db, pSample->n + 2);
danf52bb8d2013-08-03 20:24:58 +00001755 if( pSample->p==0 ){
1756 sqlite3_finalize(pStmt);
mistachkinfad30392016-02-13 23:43:46 +00001757 return SQLITE_NOMEM_BKPT;
drhfaacf172011-08-12 01:51:45 +00001758 }
dan895decf2016-12-30 14:15:56 +00001759 if( pSample->n ){
1760 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1761 }
danc367d4c2013-08-16 14:09:43 +00001762 pIdx->nSample++;
drhfaacf172011-08-12 01:51:45 +00001763 }
drh61b34402013-08-16 13:34:50 +00001764 rc = sqlite3_finalize(pStmt);
1765 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1766 return rc;
drhfaacf172011-08-12 01:51:45 +00001767}
dan0106e372013-08-12 16:34:32 +00001768
1769/*
drh175b8f02019-08-08 15:24:17 +00001770** Load content from the sqlite_stat4 table into
dan0106e372013-08-12 16:34:32 +00001771** the Index.aSample[] arrays of all indices.
1772*/
1773static int loadStat4(sqlite3 *db, const char *zDb){
1774 int rc = SQLITE_OK; /* Result codes from subroutines */
1775
drh4a642b62016-02-05 01:55:27 +00001776 assert( db->lookaside.bDisable );
dan0106e372013-08-12 16:34:32 +00001777 if( sqlite3FindTable(db, "sqlite_stat4", zDb) ){
drh175b8f02019-08-08 15:24:17 +00001778 rc = loadStatTbl(db,
dan0106e372013-08-12 16:34:32 +00001779 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx",
1780 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1781 zDb
1782 );
1783 }
dan0106e372013-08-12 16:34:32 +00001784 return rc;
1785}
drh175b8f02019-08-08 15:24:17 +00001786#endif /* SQLITE_ENABLE_STAT4 */
drhfaacf172011-08-12 01:51:45 +00001787
1788/*
drh175b8f02019-08-08 15:24:17 +00001789** Load the content of the sqlite_stat1 and sqlite_stat4 tables. The
dan85c165c2009-08-19 14:34:54 +00001790** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
drh175b8f02019-08-08 15:24:17 +00001791** arrays. The contents of sqlite_stat4 are used to populate the
dan85c165c2009-08-19 14:34:54 +00001792** Index.aSample[] arrays.
1793**
1794** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
drh175b8f02019-08-08 15:24:17 +00001795** is returned. In this case, even if SQLITE_ENABLE_STAT4 was defined
1796** during compilation and the sqlite_stat4 table is present, no data is
dan85c165c2009-08-19 14:34:54 +00001797** read from it.
1798**
drh175b8f02019-08-08 15:24:17 +00001799** If SQLITE_ENABLE_STAT4 was defined during compilation and the
danf52bb8d2013-08-03 20:24:58 +00001800** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
dan85c165c2009-08-19 14:34:54 +00001801** returned. However, in this case, data is read from the sqlite_stat1
1802** table (if it is present) before returning.
1803**
1804** If an OOM error occurs, this function always sets db->mallocFailed.
1805** This means if the caller does not care about other errors, the return
1806** code may be ignored.
drh497e4462005-07-23 03:18:40 +00001807*/
drhcf1be452007-05-12 12:08:51 +00001808int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +00001809 analysisInfo sInfo;
1810 HashElem *i;
1811 char *zSql;
drh51b55a32016-04-04 12:38:05 +00001812 int rc = SQLITE_OK;
drh33bec3f2017-02-17 13:38:15 +00001813 Schema *pSchema = db->aDb[iDb].pSchema;
drh497e4462005-07-23 03:18:40 +00001814
drhff0587c2007-08-29 17:43:19 +00001815 assert( iDb>=0 && iDb<db->nDb );
1816 assert( db->aDb[iDb].pBt!=0 );
drh1fee73e2007-08-29 04:00:57 +00001817
drh497e4462005-07-23 03:18:40 +00001818 /* Clear any prior statistics */
drh21206082011-04-04 18:22:02 +00001819 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001820 for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1821 Table *pTab = sqliteHashData(i);
1822 pTab->tabFlags &= ~TF_HasStat1;
1823 }
1824 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +00001825 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001826 pIdx->hasStat1 = 0;
drh175b8f02019-08-08 15:24:17 +00001827#ifdef SQLITE_ENABLE_STAT4
dand46def72010-07-24 11:28:28 +00001828 sqlite3DeleteIndexSamples(db, pIdx);
1829 pIdx->aSample = 0;
drhfaacf172011-08-12 01:51:45 +00001830#endif
drh497e4462005-07-23 03:18:40 +00001831 }
1832
drhf6661a82016-04-01 12:35:22 +00001833 /* Load new statistics out of the sqlite_stat1 table */
drh497e4462005-07-23 03:18:40 +00001834 sInfo.db = db;
drh69c33822016-08-18 14:33:11 +00001835 sInfo.zDatabase = db->aDb[iDb].zDbSName;
drhf6661a82016-04-01 12:35:22 +00001836 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)!=0 ){
1837 zSql = sqlite3MPrintf(db,
1838 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1839 if( zSql==0 ){
1840 rc = SQLITE_NOMEM_BKPT;
1841 }else{
1842 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1843 sqlite3DbFree(db, zSql);
1844 }
drh497e4462005-07-23 03:18:40 +00001845 }
1846
drhf6661a82016-04-01 12:35:22 +00001847 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1848 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh33bec3f2017-02-17 13:38:15 +00001849 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
drhf6661a82016-04-01 12:35:22 +00001850 Index *pIdx = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001851 if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
drhf16ce3b2009-02-13 16:59:53 +00001852 }
dan02fa4692009-08-17 17:06:58 +00001853
danf52bb8d2013-08-03 20:24:58 +00001854 /* Load the statistics from the sqlite_stat4 table. */
drh175b8f02019-08-08 15:24:17 +00001855#ifdef SQLITE_ENABLE_STAT4
drh72d03a62018-07-20 19:24:02 +00001856 if( rc==SQLITE_OK ){
drh31f69622019-10-05 14:39:36 +00001857 DisableLookaside;
danf52bb8d2013-08-03 20:24:58 +00001858 rc = loadStat4(db, sInfo.zDatabase);
drh31f69622019-10-05 14:39:36 +00001859 EnableLookaside;
dan02fa4692009-08-17 17:06:58 +00001860 }
drh33bec3f2017-02-17 13:38:15 +00001861 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
dan43085d72014-10-03 19:16:53 +00001862 Index *pIdx = sqliteHashData(i);
drh75b170b2014-10-04 00:07:44 +00001863 sqlite3_free(pIdx->aiRowEst);
dan43085d72014-10-03 19:16:53 +00001864 pIdx->aiRowEst = 0;
1865 }
dan69188d92009-08-19 08:18:32 +00001866#endif
dan02fa4692009-08-17 17:06:58 +00001867
dane275dc32009-08-18 16:24:58 +00001868 if( rc==SQLITE_NOMEM ){
drh4a642b62016-02-05 01:55:27 +00001869 sqlite3OomFault(db);
dane275dc32009-08-18 16:24:58 +00001870 }
drhcf1be452007-05-12 12:08:51 +00001871 return rc;
drh497e4462005-07-23 03:18:40 +00001872}
drh9f18e8a2005-07-08 12:13:04 +00001873
drhff2d5ea2005-07-23 00:41:48 +00001874
drh9f18e8a2005-07-08 12:13:04 +00001875#endif /* SQLITE_OMIT_ANALYZE */