Replaces use of deprecated WINAPI_FAMILY_APP macro with WINAPI_FAMILY_PC_APP
[sqlcipher.git] / src / analyze.c
blob8c48a8ff2aa29c9ec8209802df1147861f374316
1 /*
2 ** 2005-07-08
3 **
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.
11 *************************************************************************
12 ** This file contains code associated with the ANALYZE command.
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.
18 ** The following system tables are or have been supported:
20 ** CREATE TABLE sqlite_stat1(tbl, idx, stat);
21 ** CREATE TABLE sqlite_stat2(tbl, idx, sampleno, sample);
22 ** CREATE TABLE sqlite_stat3(tbl, idx, nEq, nLt, nDLt, sample);
23 ** CREATE TABLE sqlite_stat4(tbl, idx, nEq, nLt, nDLt, sample);
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
27 ** is between 3.6.18 and 3.7.8, inclusive, and unless SQLite is compiled
28 ** with SQLITE_ENABLE_STAT2. The sqlite_stat2 table is deprecated.
29 ** The sqlite_stat2 table is superseded by sqlite_stat3, which is only
30 ** created and used by SQLite versions 3.7.9 through 3.29.0 when
31 ** SQLITE_ENABLE_STAT3 defined. The functionality of sqlite_stat3
32 ** 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.
38 ** For most applications, sqlite_stat1 provides all the statistics required
39 ** for the query planner to make good choices.
41 ** Format of sqlite_stat1:
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
47 ** 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
49 ** 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.
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.
67 ** Format of sqlite_stat2:
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
71 ** 3.6.18 and 3.7.8. The "stat2" table contains additional information
72 ** 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.
77 ** The sqlite_stat2 entries for an index that have sampleno between 0 and 9
78 ** 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:
83 ** rownumber = (i*C*2 + C)/(S*2)
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.
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.
93 ** Format for sqlite_stat3:
95 ** 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.
99 ** Format for sqlite_stat4:
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.
106 ** The sqlite_stat4 table contains multiple entries for each index.
107 ** 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
109 ** of the INTEGER PRIMARY KEY. The sample column is a blob which is the
110 ** 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.
116 ** 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
118 ** 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.
126 ** There can be an arbitrary number of sqlite_stat4 entries per index.
127 ** The ANALYZE command will typically generate sqlite_stat4 tables
128 ** that contain between 10 and 40 samples which are distributed across
129 ** the key space, though not uniformly, and which include samples with
130 ** large nEq values.
132 ** Format for sqlite_stat3 redux:
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.
142 #ifndef SQLITE_OMIT_ANALYZE
143 #include "sqliteInt.h"
145 #if defined(SQLITE_ENABLE_STAT4)
146 # define IsStat4 1
147 #else
148 # define IsStat4 0
149 # undef SQLITE_STAT4_SAMPLES
150 # define SQLITE_STAT4_SAMPLES 1
151 #endif
154 ** 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.
159 ** If the sqlite_statN tables do not previously exist, it is created.
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
163 ** 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.
166 static 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 */
170 const char *zWhere, /* Delete entries for this table or index */
171 const char *zWhereType /* Either "tbl" or "idx" */
173 static const struct {
174 const char *zName;
175 const char *zCols;
176 } aTable[] = {
177 { "sqlite_stat1", "tbl,idx,stat" },
178 #if defined(SQLITE_ENABLE_STAT4)
179 { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
180 #else
181 { "sqlite_stat4", 0 },
182 #endif
183 { "sqlite_stat3", 0 },
185 int i;
186 sqlite3 *db = pParse->db;
187 Db *pDb;
188 Vdbe *v = sqlite3GetVdbe(pParse);
189 u32 aRoot[ArraySize(aTable)];
190 u8 aCreateTbl[ArraySize(aTable)];
191 #ifdef SQLITE_ENABLE_STAT4
192 const int nToOpen = OptimizationEnabled(db,SQLITE_Stat4) ? 2 : 1;
193 #else
194 const int nToOpen = 1;
195 #endif
197 if( v==0 ) return;
198 assert( sqlite3BtreeHoldsAllMutexes(db) );
199 assert( sqlite3VdbeDb(v)==db );
200 pDb = &db->aDb[iDb];
202 /* Create new statistic tables if they do not exist, or clear them
203 ** if they do already exist.
205 for(i=0; i<ArraySize(aTable); i++){
206 const char *zTab = aTable[i].zName;
207 Table *pStat;
208 aCreateTbl[i] = 0;
209 if( (pStat = sqlite3FindTable(db, zTab, pDb->zDbSName))==0 ){
210 if( i<nToOpen ){
211 /* The sqlite_statN table does not exist. Create it. Note that a
212 ** side-effect of the CREATE TABLE statement is to leave the rootpage
213 ** of the new table in register pParse->regRoot. This is important
214 ** because the OpenWrite opcode below will be needing it. */
215 sqlite3NestedParse(pParse,
216 "CREATE TABLE %Q.%s(%s)", pDb->zDbSName, zTab, aTable[i].zCols
218 aRoot[i] = (u32)pParse->regRoot;
219 aCreateTbl[i] = OPFLAG_P2ISREG;
221 }else{
222 /* The table already exists. If zWhere is not NULL, delete all entries
223 ** associated with the table zWhere. If zWhere is NULL, delete the
224 ** entire contents of the table. */
225 aRoot[i] = pStat->tnum;
226 sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
227 if( zWhere ){
228 sqlite3NestedParse(pParse,
229 "DELETE FROM %Q.%s WHERE %s=%Q",
230 pDb->zDbSName, zTab, zWhereType, zWhere
232 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
233 }else if( db->xPreUpdateCallback ){
234 sqlite3NestedParse(pParse, "DELETE FROM %Q.%s", pDb->zDbSName, zTab);
235 #endif
236 }else{
237 /* The sqlite_stat[134] table already exists. Delete all rows. */
238 sqlite3VdbeAddOp2(v, OP_Clear, (int)aRoot[i], iDb);
243 /* Open the sqlite_stat[134] tables for writing. */
244 for(i=0; i<nToOpen; i++){
245 assert( i<ArraySize(aTable) );
246 sqlite3VdbeAddOp4Int(v, OP_OpenWrite, iStatCur+i, (int)aRoot[i], iDb, 3);
247 sqlite3VdbeChangeP5(v, aCreateTbl[i]);
248 VdbeComment((v, aTable[i].zName));
253 ** Recommended number of samples for sqlite_stat4
255 #ifndef SQLITE_STAT4_SAMPLES
256 # define SQLITE_STAT4_SAMPLES 24
257 #endif
260 ** Three SQL functions - stat_init(), stat_push(), and stat_get() -
261 ** share an instance of the following structure to hold their state
262 ** information.
264 typedef struct StatAccum StatAccum;
265 typedef struct StatSample StatSample;
266 struct StatSample {
267 tRowcnt *anDLt; /* sqlite_stat4.nDLt */
268 #ifdef SQLITE_ENABLE_STAT4
269 tRowcnt *anEq; /* sqlite_stat4.nEq */
270 tRowcnt *anLt; /* sqlite_stat4.nLt */
271 union {
272 i64 iRowid; /* Rowid in main table of the key */
273 u8 *aRowid; /* Key for WITHOUT ROWID tables */
274 } u;
275 u32 nRowid; /* Sizeof aRowid[] */
276 u8 isPSample; /* True if a periodic sample */
277 int iCol; /* If !isPSample, the reason for inclusion */
278 u32 iHash; /* Tiebreaker hash */
279 #endif
281 struct StatAccum {
282 sqlite3 *db; /* Database connection, for malloc() */
283 tRowcnt nEst; /* Estimated number of rows */
284 tRowcnt nRow; /* Number of rows visited so far */
285 int nLimit; /* Analysis row-scan limit */
286 int nCol; /* Number of columns in index + pk/rowid */
287 int nKeyCol; /* Number of index columns w/o the pk/rowid */
288 u8 nSkipAhead; /* Number of times of skip-ahead */
289 StatSample current; /* Current row as a StatSample */
290 #ifdef SQLITE_ENABLE_STAT4
291 tRowcnt nPSample; /* How often to do a periodic sample */
292 int mxSample; /* Maximum number of samples to accumulate */
293 u32 iPrn; /* Pseudo-random number used for sampling */
294 StatSample *aBest; /* Array of nCol best samples */
295 int iMin; /* Index in a[] of entry with minimum score */
296 int nSample; /* Current number of samples */
297 int nMaxEqZero; /* Max leading 0 in anEq[] for any a[] entry */
298 int iGet; /* Index of current sample accessed by stat_get() */
299 StatSample *a; /* Array of mxSample StatSample objects */
300 #endif
303 /* Reclaim memory used by a StatSample
305 #ifdef SQLITE_ENABLE_STAT4
306 static void sampleClear(sqlite3 *db, StatSample *p){
307 assert( db!=0 );
308 if( p->nRowid ){
309 sqlite3DbFree(db, p->u.aRowid);
310 p->nRowid = 0;
313 #endif
315 /* Initialize the BLOB value of a ROWID
317 #ifdef SQLITE_ENABLE_STAT4
318 static void sampleSetRowid(sqlite3 *db, StatSample *p, int n, const u8 *pData){
319 assert( db!=0 );
320 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
321 p->u.aRowid = sqlite3DbMallocRawNN(db, n);
322 if( p->u.aRowid ){
323 p->nRowid = n;
324 memcpy(p->u.aRowid, pData, n);
325 }else{
326 p->nRowid = 0;
329 #endif
331 /* Initialize the INTEGER value of a ROWID.
333 #ifdef SQLITE_ENABLE_STAT4
334 static void sampleSetRowidInt64(sqlite3 *db, StatSample *p, i64 iRowid){
335 assert( db!=0 );
336 if( p->nRowid ) sqlite3DbFree(db, p->u.aRowid);
337 p->nRowid = 0;
338 p->u.iRowid = iRowid;
340 #endif
344 ** Copy the contents of object (*pFrom) into (*pTo).
346 #ifdef SQLITE_ENABLE_STAT4
347 static void sampleCopy(StatAccum *p, StatSample *pTo, StatSample *pFrom){
348 pTo->isPSample = pFrom->isPSample;
349 pTo->iCol = pFrom->iCol;
350 pTo->iHash = pFrom->iHash;
351 memcpy(pTo->anEq, pFrom->anEq, sizeof(tRowcnt)*p->nCol);
352 memcpy(pTo->anLt, pFrom->anLt, sizeof(tRowcnt)*p->nCol);
353 memcpy(pTo->anDLt, pFrom->anDLt, sizeof(tRowcnt)*p->nCol);
354 if( pFrom->nRowid ){
355 sampleSetRowid(p->db, pTo, pFrom->nRowid, pFrom->u.aRowid);
356 }else{
357 sampleSetRowidInt64(p->db, pTo, pFrom->u.iRowid);
360 #endif
363 ** Reclaim all memory of a StatAccum structure.
365 static void statAccumDestructor(void *pOld){
366 StatAccum *p = (StatAccum*)pOld;
367 #ifdef SQLITE_ENABLE_STAT4
368 if( p->mxSample ){
369 int i;
370 for(i=0; i<p->nCol; i++) sampleClear(p->db, p->aBest+i);
371 for(i=0; i<p->mxSample; i++) sampleClear(p->db, p->a+i);
372 sampleClear(p->db, &p->current);
374 #endif
375 sqlite3DbFree(p->db, p);
379 ** Implementation of the stat_init(N,K,C,L) SQL function. The four parameters
380 ** are:
381 ** N: The number of columns in the index including the rowid/pk (note 1)
382 ** K: The number of columns in the index excluding the rowid/pk.
383 ** C: Estimated number of rows in the index
384 ** L: A limit on the number of rows to scan, or 0 for no-limit
386 ** Note 1: In the special case of the covering index that implements a
387 ** WITHOUT ROWID table, N is the number of PRIMARY KEY columns, not the
388 ** total number of columns in the table.
390 ** For indexes on ordinary rowid tables, N==K+1. But for indexes on
391 ** WITHOUT ROWID tables, N=K+P where P is the number of columns in the
392 ** PRIMARY KEY of the table. The covering index that implements the
393 ** original WITHOUT ROWID table as N==K as a special case.
395 ** This routine allocates the StatAccum object in heap memory. The return
396 ** value is a pointer to the StatAccum object. The datatype of the
397 ** return value is BLOB, but it is really just a pointer to the StatAccum
398 ** object.
400 static void statInit(
401 sqlite3_context *context,
402 int argc,
403 sqlite3_value **argv
405 StatAccum *p;
406 int nCol; /* Number of columns in index being sampled */
407 int nKeyCol; /* Number of key columns */
408 int nColUp; /* nCol rounded up for alignment */
409 int n; /* Bytes of space to allocate */
410 sqlite3 *db = sqlite3_context_db_handle(context); /* Database connection */
411 #ifdef SQLITE_ENABLE_STAT4
412 /* Maximum number of samples. 0 if STAT4 data is not collected */
413 int mxSample = OptimizationEnabled(db,SQLITE_Stat4) ?SQLITE_STAT4_SAMPLES :0;
414 #endif
416 /* Decode the three function arguments */
417 UNUSED_PARAMETER(argc);
418 nCol = sqlite3_value_int(argv[0]);
419 assert( nCol>0 );
420 nColUp = sizeof(tRowcnt)<8 ? (nCol+1)&~1 : nCol;
421 nKeyCol = sqlite3_value_int(argv[1]);
422 assert( nKeyCol<=nCol );
423 assert( nKeyCol>0 );
425 /* Allocate the space required for the StatAccum object */
426 n = sizeof(*p)
427 + sizeof(tRowcnt)*nColUp; /* StatAccum.anDLt */
428 #ifdef SQLITE_ENABLE_STAT4
429 n += sizeof(tRowcnt)*nColUp; /* StatAccum.anEq */
430 if( mxSample ){
431 n += sizeof(tRowcnt)*nColUp /* StatAccum.anLt */
432 + sizeof(StatSample)*(nCol+mxSample) /* StatAccum.aBest[], a[] */
433 + sizeof(tRowcnt)*3*nColUp*(nCol+mxSample);
435 #endif
436 p = sqlite3DbMallocZero(db, n);
437 if( p==0 ){
438 sqlite3_result_error_nomem(context);
439 return;
442 p->db = db;
443 p->nEst = sqlite3_value_int64(argv[2]);
444 p->nRow = 0;
445 p->nLimit = sqlite3_value_int64(argv[3]);
446 p->nCol = nCol;
447 p->nKeyCol = nKeyCol;
448 p->nSkipAhead = 0;
449 p->current.anDLt = (tRowcnt*)&p[1];
451 #ifdef SQLITE_ENABLE_STAT4
452 p->current.anEq = &p->current.anDLt[nColUp];
453 p->mxSample = p->nLimit==0 ? mxSample : 0;
454 if( mxSample ){
455 u8 *pSpace; /* Allocated space not yet assigned */
456 int i; /* Used to iterate through p->aSample[] */
458 p->iGet = -1;
459 p->nPSample = (tRowcnt)(p->nEst/(mxSample/3+1) + 1);
460 p->current.anLt = &p->current.anEq[nColUp];
461 p->iPrn = 0x689e962d*(u32)nCol ^ 0xd0944565*(u32)sqlite3_value_int(argv[2]);
463 /* Set up the StatAccum.a[] and aBest[] arrays */
464 p->a = (struct StatSample*)&p->current.anLt[nColUp];
465 p->aBest = &p->a[mxSample];
466 pSpace = (u8*)(&p->a[mxSample+nCol]);
467 for(i=0; i<(mxSample+nCol); i++){
468 p->a[i].anEq = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
469 p->a[i].anLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
470 p->a[i].anDLt = (tRowcnt *)pSpace; pSpace += (sizeof(tRowcnt) * nColUp);
472 assert( (pSpace - (u8*)p)==n );
474 for(i=0; i<nCol; i++){
475 p->aBest[i].iCol = i;
478 #endif
480 /* Return a pointer to the allocated object to the caller. Note that
481 ** only the pointer (the 2nd parameter) matters. The size of the object
482 ** (given by the 3rd parameter) is never used and can be any positive
483 ** value. */
484 sqlite3_result_blob(context, p, sizeof(*p), statAccumDestructor);
486 static const FuncDef statInitFuncdef = {
487 4, /* nArg */
488 SQLITE_UTF8, /* funcFlags */
489 0, /* pUserData */
490 0, /* pNext */
491 statInit, /* xSFunc */
492 0, /* xFinalize */
493 0, 0, /* xValue, xInverse */
494 "stat_init", /* zName */
498 #ifdef SQLITE_ENABLE_STAT4
500 ** pNew and pOld are both candidate non-periodic samples selected for
501 ** the same column (pNew->iCol==pOld->iCol). Ignoring this column and
502 ** considering only any trailing columns and the sample hash value, this
503 ** function returns true if sample pNew is to be preferred over pOld.
504 ** In other words, if we assume that the cardinalities of the selected
505 ** column for pNew and pOld are equal, is pNew to be preferred over pOld.
507 ** This function assumes that for each argument sample, the contents of
508 ** the anEq[] array from pSample->anEq[pSample->iCol+1] onwards are valid.
510 static int sampleIsBetterPost(
511 StatAccum *pAccum,
512 StatSample *pNew,
513 StatSample *pOld
515 int nCol = pAccum->nCol;
516 int i;
517 assert( pNew->iCol==pOld->iCol );
518 for(i=pNew->iCol+1; i<nCol; i++){
519 if( pNew->anEq[i]>pOld->anEq[i] ) return 1;
520 if( pNew->anEq[i]<pOld->anEq[i] ) return 0;
522 if( pNew->iHash>pOld->iHash ) return 1;
523 return 0;
525 #endif
527 #ifdef SQLITE_ENABLE_STAT4
529 ** Return true if pNew is to be preferred over pOld.
531 ** This function assumes that for each argument sample, the contents of
532 ** the anEq[] array from pSample->anEq[pSample->iCol] onwards are valid.
534 static int sampleIsBetter(
535 StatAccum *pAccum,
536 StatSample *pNew,
537 StatSample *pOld
539 tRowcnt nEqNew = pNew->anEq[pNew->iCol];
540 tRowcnt nEqOld = pOld->anEq[pOld->iCol];
542 assert( pOld->isPSample==0 && pNew->isPSample==0 );
543 assert( IsStat4 || (pNew->iCol==0 && pOld->iCol==0) );
545 if( (nEqNew>nEqOld) ) return 1;
546 if( nEqNew==nEqOld ){
547 if( pNew->iCol<pOld->iCol ) return 1;
548 return (pNew->iCol==pOld->iCol && sampleIsBetterPost(pAccum, pNew, pOld));
550 return 0;
554 ** Copy the contents of sample *pNew into the p->a[] array. If necessary,
555 ** remove the least desirable sample from p->a[] to make room.
557 static void sampleInsert(StatAccum *p, StatSample *pNew, int nEqZero){
558 StatSample *pSample = 0;
559 int i;
561 assert( IsStat4 || nEqZero==0 );
563 /* StatAccum.nMaxEqZero is set to the maximum number of leading 0
564 ** values in the anEq[] array of any sample in StatAccum.a[]. In
565 ** other words, if nMaxEqZero is n, then it is guaranteed that there
566 ** are no samples with StatSample.anEq[m]==0 for (m>=n). */
567 if( nEqZero>p->nMaxEqZero ){
568 p->nMaxEqZero = nEqZero;
570 if( pNew->isPSample==0 ){
571 StatSample *pUpgrade = 0;
572 assert( pNew->anEq[pNew->iCol]>0 );
574 /* This sample is being added because the prefix that ends in column
575 ** iCol occurs many times in the table. However, if we have already
576 ** added a sample that shares this prefix, there is no need to add
577 ** this one. Instead, upgrade the priority of the highest priority
578 ** existing sample that shares this prefix. */
579 for(i=p->nSample-1; i>=0; i--){
580 StatSample *pOld = &p->a[i];
581 if( pOld->anEq[pNew->iCol]==0 ){
582 if( pOld->isPSample ) return;
583 assert( pOld->iCol>pNew->iCol );
584 assert( sampleIsBetter(p, pNew, pOld) );
585 if( pUpgrade==0 || sampleIsBetter(p, pOld, pUpgrade) ){
586 pUpgrade = pOld;
590 if( pUpgrade ){
591 pUpgrade->iCol = pNew->iCol;
592 pUpgrade->anEq[pUpgrade->iCol] = pNew->anEq[pUpgrade->iCol];
593 goto find_new_min;
597 /* If necessary, remove sample iMin to make room for the new sample. */
598 if( p->nSample>=p->mxSample ){
599 StatSample *pMin = &p->a[p->iMin];
600 tRowcnt *anEq = pMin->anEq;
601 tRowcnt *anLt = pMin->anLt;
602 tRowcnt *anDLt = pMin->anDLt;
603 sampleClear(p->db, pMin);
604 memmove(pMin, &pMin[1], sizeof(p->a[0])*(p->nSample-p->iMin-1));
605 pSample = &p->a[p->nSample-1];
606 pSample->nRowid = 0;
607 pSample->anEq = anEq;
608 pSample->anDLt = anDLt;
609 pSample->anLt = anLt;
610 p->nSample = p->mxSample-1;
613 /* The "rows less-than" for the rowid column must be greater than that
614 ** for the last sample in the p->a[] array. Otherwise, the samples would
615 ** be out of order. */
616 assert( p->nSample==0
617 || pNew->anLt[p->nCol-1] > p->a[p->nSample-1].anLt[p->nCol-1] );
619 /* Insert the new sample */
620 pSample = &p->a[p->nSample];
621 sampleCopy(p, pSample, pNew);
622 p->nSample++;
624 /* Zero the first nEqZero entries in the anEq[] array. */
625 memset(pSample->anEq, 0, sizeof(tRowcnt)*nEqZero);
627 find_new_min:
628 if( p->nSample>=p->mxSample ){
629 int iMin = -1;
630 for(i=0; i<p->mxSample; i++){
631 if( p->a[i].isPSample ) continue;
632 if( iMin<0 || sampleIsBetter(p, &p->a[iMin], &p->a[i]) ){
633 iMin = i;
636 assert( iMin>=0 );
637 p->iMin = iMin;
640 #endif /* SQLITE_ENABLE_STAT4 */
642 #ifdef SQLITE_ENABLE_STAT4
644 ** Field iChng of the index being scanned has changed. So at this point
645 ** p->current contains a sample that reflects the previous row of the
646 ** index. The value of anEq[iChng] and subsequent anEq[] elements are
647 ** correct at this point.
649 static void samplePushPrevious(StatAccum *p, int iChng){
650 int i;
652 /* Check if any samples from the aBest[] array should be pushed
653 ** into IndexSample.a[] at this point. */
654 for(i=(p->nCol-2); i>=iChng; i--){
655 StatSample *pBest = &p->aBest[i];
656 pBest->anEq[i] = p->current.anEq[i];
657 if( p->nSample<p->mxSample || sampleIsBetter(p, pBest, &p->a[p->iMin]) ){
658 sampleInsert(p, pBest, i);
662 /* Check that no sample contains an anEq[] entry with an index of
663 ** p->nMaxEqZero or greater set to zero. */
664 for(i=p->nSample-1; i>=0; i--){
665 int j;
666 for(j=p->nMaxEqZero; j<p->nCol; j++) assert( p->a[i].anEq[j]>0 );
669 /* Update the anEq[] fields of any samples already collected. */
670 if( iChng<p->nMaxEqZero ){
671 for(i=p->nSample-1; i>=0; i--){
672 int j;
673 for(j=iChng; j<p->nCol; j++){
674 if( p->a[i].anEq[j]==0 ) p->a[i].anEq[j] = p->current.anEq[j];
677 p->nMaxEqZero = iChng;
680 #endif /* SQLITE_ENABLE_STAT4 */
683 ** Implementation of the stat_push SQL function: stat_push(P,C,R)
684 ** Arguments:
686 ** P Pointer to the StatAccum object created by stat_init()
687 ** C Index of left-most column to differ from previous row
688 ** R Rowid for the current row. Might be a key record for
689 ** WITHOUT ROWID tables.
691 ** The purpose of this routine is to collect statistical data and/or
692 ** samples from the index being analyzed into the StatAccum object.
693 ** The stat_get() SQL function will be used afterwards to
694 ** retrieve the information gathered.
696 ** This SQL function usually returns NULL, but might return an integer
697 ** if it wants the byte-code to do special processing.
699 ** The R parameter is only used for STAT4
701 static void statPush(
702 sqlite3_context *context,
703 int argc,
704 sqlite3_value **argv
706 int i;
708 /* The three function arguments */
709 StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
710 int iChng = sqlite3_value_int(argv[1]);
712 UNUSED_PARAMETER( argc );
713 UNUSED_PARAMETER( context );
714 assert( p->nCol>0 );
715 assert( iChng<p->nCol );
717 if( p->nRow==0 ){
718 /* This is the first call to this function. Do initialization. */
719 #ifdef SQLITE_ENABLE_STAT4
720 for(i=0; i<p->nCol; i++) p->current.anEq[i] = 1;
721 #endif
722 }else{
723 /* Second and subsequent calls get processed here */
724 #ifdef SQLITE_ENABLE_STAT4
725 if( p->mxSample ) samplePushPrevious(p, iChng);
726 #endif
728 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
729 ** to the current row of the index. */
730 #ifdef SQLITE_ENABLE_STAT4
731 for(i=0; i<iChng; i++){
732 p->current.anEq[i]++;
734 #endif
735 for(i=iChng; i<p->nCol; i++){
736 p->current.anDLt[i]++;
737 #ifdef SQLITE_ENABLE_STAT4
738 if( p->mxSample ) p->current.anLt[i] += p->current.anEq[i];
739 p->current.anEq[i] = 1;
740 #endif
744 p->nRow++;
745 #ifdef SQLITE_ENABLE_STAT4
746 if( p->mxSample ){
747 tRowcnt nLt;
748 if( sqlite3_value_type(argv[2])==SQLITE_INTEGER ){
749 sampleSetRowidInt64(p->db, &p->current, sqlite3_value_int64(argv[2]));
750 }else{
751 sampleSetRowid(p->db, &p->current, sqlite3_value_bytes(argv[2]),
752 sqlite3_value_blob(argv[2]));
754 p->current.iHash = p->iPrn = p->iPrn*1103515245 + 12345;
756 nLt = p->current.anLt[p->nCol-1];
757 /* Check if this is to be a periodic sample. If so, add it. */
758 if( (nLt/p->nPSample)!=(nLt+1)/p->nPSample ){
759 p->current.isPSample = 1;
760 p->current.iCol = 0;
761 sampleInsert(p, &p->current, p->nCol-1);
762 p->current.isPSample = 0;
765 /* Update the aBest[] array. */
766 for(i=0; i<(p->nCol-1); i++){
767 p->current.iCol = i;
768 if( i>=iChng || sampleIsBetterPost(p, &p->current, &p->aBest[i]) ){
769 sampleCopy(p, &p->aBest[i], &p->current);
772 }else
773 #endif
774 if( p->nLimit && p->nRow>(tRowcnt)p->nLimit*(p->nSkipAhead+1) ){
775 p->nSkipAhead++;
776 sqlite3_result_int(context, p->current.anDLt[0]>0);
780 static const FuncDef statPushFuncdef = {
781 2+IsStat4, /* nArg */
782 SQLITE_UTF8, /* funcFlags */
783 0, /* pUserData */
784 0, /* pNext */
785 statPush, /* xSFunc */
786 0, /* xFinalize */
787 0, 0, /* xValue, xInverse */
788 "stat_push", /* zName */
792 #define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
793 #define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
794 #define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
795 #define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
796 #define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
799 ** Implementation of the stat_get(P,J) SQL function. This routine is
800 ** used to query statistical information that has been gathered into
801 ** the StatAccum object by prior calls to stat_push(). The P parameter
802 ** has type BLOB but it is really just a pointer to the StatAccum object.
803 ** The content to returned is determined by the parameter J
804 ** which is one of the STAT_GET_xxxx values defined above.
806 ** The stat_get(P,J) function is not available to generic SQL. It is
807 ** inserted as part of a manually constructed bytecode program. (See
808 ** the callStatGet() routine below.) It is guaranteed that the P
809 ** parameter will always be a pointer to a StatAccum object, never a
810 ** NULL.
812 ** If STAT4 is not enabled, then J is always
813 ** STAT_GET_STAT1 and is hence omitted and this routine becomes
814 ** a one-parameter function, stat_get(P), that always returns the
815 ** stat1 table entry information.
817 static void statGet(
818 sqlite3_context *context,
819 int argc,
820 sqlite3_value **argv
822 StatAccum *p = (StatAccum*)sqlite3_value_blob(argv[0]);
823 #ifdef SQLITE_ENABLE_STAT4
824 /* STAT4 has a parameter on this routine. */
825 int eCall = sqlite3_value_int(argv[1]);
826 assert( argc==2 );
827 assert( eCall==STAT_GET_STAT1 || eCall==STAT_GET_NEQ
828 || eCall==STAT_GET_ROWID || eCall==STAT_GET_NLT
829 || eCall==STAT_GET_NDLT
831 assert( eCall==STAT_GET_STAT1 || p->mxSample );
832 if( eCall==STAT_GET_STAT1 )
833 #else
834 assert( argc==1 );
835 #endif
837 /* Return the value to store in the "stat" column of the sqlite_stat1
838 ** table for this index.
840 ** The value is a string composed of a list of integers describing
841 ** the index. The first integer in the list is the total number of
842 ** entries in the index. There is one additional integer in the list
843 ** for each indexed column. This additional integer is an estimate of
844 ** the number of rows matched by a equality query on the index using
845 ** a key with the corresponding number of fields. In other words,
846 ** if the index is on columns (a,b) and the sqlite_stat1 value is
847 ** "100 10 2", then SQLite estimates that:
849 ** * the index contains 100 rows,
850 ** * "WHERE a=?" matches 10 rows, and
851 ** * "WHERE a=? AND b=?" matches 2 rows.
853 ** If D is the count of distinct values and K is the total number of
854 ** rows, then each estimate is usually computed as:
856 ** I = (K+D-1)/D
858 ** In other words, I is K/D rounded up to the next whole integer.
859 ** However, if I is between 1.0 and 1.1 (in other words if I is
860 ** close to 1.0 but just a little larger) then do not round up but
861 ** instead keep the I value at 1.0.
863 sqlite3_str sStat; /* Text of the constructed "stat" line */
864 int i; /* Loop counter */
866 sqlite3StrAccumInit(&sStat, 0, 0, 0, (p->nKeyCol+1)*100);
867 sqlite3_str_appendf(&sStat, "%llu",
868 p->nSkipAhead ? (u64)p->nEst : (u64)p->nRow);
869 for(i=0; i<p->nKeyCol; i++){
870 u64 nDistinct = p->current.anDLt[i] + 1;
871 u64 iVal = (p->nRow + nDistinct - 1) / nDistinct;
872 if( iVal==2 && p->nRow*10 <= nDistinct*11 ) iVal = 1;
873 sqlite3_str_appendf(&sStat, " %llu", iVal);
874 #ifdef SQLITE_ENABLE_STAT4
875 assert( p->current.anEq[i] || p->nRow==0 );
876 #endif
878 sqlite3ResultStrAccum(context, &sStat);
880 #ifdef SQLITE_ENABLE_STAT4
881 else if( eCall==STAT_GET_ROWID ){
882 if( p->iGet<0 ){
883 samplePushPrevious(p, 0);
884 p->iGet = 0;
886 if( p->iGet<p->nSample ){
887 StatSample *pS = p->a + p->iGet;
888 if( pS->nRowid==0 ){
889 sqlite3_result_int64(context, pS->u.iRowid);
890 }else{
891 sqlite3_result_blob(context, pS->u.aRowid, pS->nRowid,
892 SQLITE_TRANSIENT);
895 }else{
896 tRowcnt *aCnt = 0;
897 sqlite3_str sStat;
898 int i;
900 assert( p->iGet<p->nSample );
901 switch( eCall ){
902 case STAT_GET_NEQ: aCnt = p->a[p->iGet].anEq; break;
903 case STAT_GET_NLT: aCnt = p->a[p->iGet].anLt; break;
904 default: {
905 aCnt = p->a[p->iGet].anDLt;
906 p->iGet++;
907 break;
910 sqlite3StrAccumInit(&sStat, 0, 0, 0, p->nCol*100);
911 for(i=0; i<p->nCol; i++){
912 sqlite3_str_appendf(&sStat, "%llu ", (u64)aCnt[i]);
914 if( sStat.nChar ) sStat.nChar--;
915 sqlite3ResultStrAccum(context, &sStat);
917 #endif /* SQLITE_ENABLE_STAT4 */
918 #ifndef SQLITE_DEBUG
919 UNUSED_PARAMETER( argc );
920 #endif
922 static const FuncDef statGetFuncdef = {
923 1+IsStat4, /* nArg */
924 SQLITE_UTF8, /* funcFlags */
925 0, /* pUserData */
926 0, /* pNext */
927 statGet, /* xSFunc */
928 0, /* xFinalize */
929 0, 0, /* xValue, xInverse */
930 "stat_get", /* zName */
934 static void callStatGet(Parse *pParse, int regStat, int iParam, int regOut){
935 #ifdef SQLITE_ENABLE_STAT4
936 sqlite3VdbeAddOp2(pParse->pVdbe, OP_Integer, iParam, regStat+1);
937 #elif SQLITE_DEBUG
938 assert( iParam==STAT_GET_STAT1 );
939 #else
940 UNUSED_PARAMETER( iParam );
941 #endif
942 assert( regOut!=regStat && regOut!=regStat+1 );
943 sqlite3VdbeAddFunctionCall(pParse, 0, regStat, regOut, 1+IsStat4,
944 &statGetFuncdef, 0);
947 #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
948 /* Add a comment to the most recent VDBE opcode that is the name
949 ** of the k-th column of the pIdx index.
951 static void analyzeVdbeCommentIndexWithColumnName(
952 Vdbe *v, /* Prepared statement under construction */
953 Index *pIdx, /* Index whose column is being loaded */
954 int k /* Which column index */
956 int i; /* Index of column in the table */
957 assert( k>=0 && k<pIdx->nColumn );
958 i = pIdx->aiColumn[k];
959 if( NEVER(i==XN_ROWID) ){
960 VdbeComment((v,"%s.rowid",pIdx->zName));
961 }else if( i==XN_EXPR ){
962 assert( pIdx->bHasExpr );
963 VdbeComment((v,"%s.expr(%d)",pIdx->zName, k));
964 }else{
965 VdbeComment((v,"%s.%s", pIdx->zName, pIdx->pTable->aCol[i].zCnName));
968 #else
969 # define analyzeVdbeCommentIndexWithColumnName(a,b,c)
970 #endif /* SQLITE_DEBUG */
973 ** Generate code to do an analysis of all indices associated with
974 ** a single table.
976 static void analyzeOneTable(
977 Parse *pParse, /* Parser context */
978 Table *pTab, /* Table whose indices are to be analyzed */
979 Index *pOnlyIdx, /* If not NULL, only analyze this one index */
980 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
981 int iMem, /* Available memory locations begin here */
982 int iTab /* Next available cursor */
984 sqlite3 *db = pParse->db; /* Database handle */
985 Index *pIdx; /* An index to being analyzed */
986 int iIdxCur; /* Cursor open on index being analyzed */
987 int iTabCur; /* Table cursor */
988 Vdbe *v; /* The virtual machine being built up */
989 int i; /* Loop counter */
990 int jZeroRows = -1; /* Jump from here if number of rows is zero */
991 int iDb; /* Index of database containing pTab */
992 u8 needTableCnt = 1; /* True to count the table */
993 int regNewRowid = iMem++; /* Rowid for the inserted record */
994 int regStat = iMem++; /* Register to hold StatAccum object */
995 int regChng = iMem++; /* Index of changed index field */
996 int regRowid = iMem++; /* Rowid argument passed to stat_push() */
997 int regTemp = iMem++; /* Temporary use register */
998 int regTemp2 = iMem++; /* Second temporary use register */
999 int regTabname = iMem++; /* Register containing table name */
1000 int regIdxname = iMem++; /* Register containing index name */
1001 int regStat1 = iMem++; /* Value for the stat column of sqlite_stat1 */
1002 int regPrev = iMem; /* MUST BE LAST (see below) */
1003 #ifdef SQLITE_ENABLE_STAT4
1004 int doOnce = 1; /* Flag for a one-time computation */
1005 #endif
1006 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1007 Table *pStat1 = 0;
1008 #endif
1010 sqlite3TouchRegister(pParse, iMem);
1011 assert( sqlite3NoTempsInRange(pParse, regNewRowid, iMem) );
1012 v = sqlite3GetVdbe(pParse);
1013 if( v==0 || NEVER(pTab==0) ){
1014 return;
1016 if( !IsOrdinaryTable(pTab) ){
1017 /* Do not gather statistics on views or virtual tables */
1018 return;
1020 if( sqlite3_strlike("sqlite\\_%", pTab->zName, '\\')==0 ){
1021 /* Do not gather statistics on system tables */
1022 return;
1024 assert( sqlite3BtreeHoldsAllMutexes(db) );
1025 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1026 assert( iDb>=0 );
1027 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1028 #ifndef SQLITE_OMIT_AUTHORIZATION
1029 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
1030 db->aDb[iDb].zDbSName ) ){
1031 return;
1033 #endif
1035 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1036 if( db->xPreUpdateCallback ){
1037 pStat1 = (Table*)sqlite3DbMallocZero(db, sizeof(Table) + 13);
1038 if( pStat1==0 ) return;
1039 pStat1->zName = (char*)&pStat1[1];
1040 memcpy(pStat1->zName, "sqlite_stat1", 13);
1041 pStat1->nCol = 3;
1042 pStat1->iPKey = -1;
1043 sqlite3VdbeAddOp4(pParse->pVdbe, OP_Noop, 0, 0, 0,(char*)pStat1,P4_DYNAMIC);
1045 #endif
1047 /* Establish a read-lock on the table at the shared-cache level.
1048 ** Open a read-only cursor on the table. Also allocate a cursor number
1049 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1050 ** this time though. */
1051 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
1052 iTabCur = iTab++;
1053 iIdxCur = iTab++;
1054 pParse->nTab = MAX(pParse->nTab, iTab);
1055 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
1056 sqlite3VdbeLoadString(v, regTabname, pTab->zName);
1058 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1059 int nCol; /* Number of columns in pIdx. "N" */
1060 int addrGotoEnd; /* Address of "OP_Rewind iIdxCur" */
1061 int addrNextRow; /* Address of "next_row:" */
1062 const char *zIdxName; /* Name of the index */
1063 int nColTest; /* Number of columns to test for changes */
1065 if( pOnlyIdx && pOnlyIdx!=pIdx ) continue;
1066 if( pIdx->pPartIdxWhere==0 ) needTableCnt = 0;
1067 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pIdx) ){
1068 nCol = pIdx->nKeyCol;
1069 zIdxName = pTab->zName;
1070 nColTest = nCol - 1;
1071 }else{
1072 nCol = pIdx->nColumn;
1073 zIdxName = pIdx->zName;
1074 nColTest = pIdx->uniqNotNull ? pIdx->nKeyCol-1 : nCol-1;
1077 /* Populate the register containing the index name. */
1078 sqlite3VdbeLoadString(v, regIdxname, zIdxName);
1079 VdbeComment((v, "Analysis for %s.%s", pTab->zName, zIdxName));
1082 ** Pseudo-code for loop that calls stat_push():
1084 ** regChng = 0
1085 ** Rewind csr
1086 ** if eof(csr){
1087 ** stat_init() with count = 0;
1088 ** goto end_of_scan;
1089 ** }
1090 ** count()
1091 ** stat_init()
1092 ** goto chng_addr_0;
1094 ** next_row:
1095 ** regChng = 0
1096 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1097 ** regChng = 1
1098 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1099 ** ...
1100 ** regChng = N
1101 ** goto chng_addr_N
1103 ** chng_addr_0:
1104 ** regPrev(0) = idx(0)
1105 ** chng_addr_1:
1106 ** regPrev(1) = idx(1)
1107 ** ...
1109 ** endDistinctTest:
1110 ** regRowid = idx(rowid)
1111 ** stat_push(P, regChng, regRowid)
1112 ** Next csr
1113 ** if !eof(csr) goto next_row;
1115 ** end_of_scan:
1118 /* Make sure there are enough memory cells allocated to accommodate
1119 ** the regPrev array and a trailing rowid (the rowid slot is required
1120 ** when building a record to insert into the sample column of
1121 ** the sqlite_stat4 table. */
1122 sqlite3TouchRegister(pParse, regPrev+nColTest);
1124 /* Open a read-only cursor on the index being analyzed. */
1125 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
1126 sqlite3VdbeAddOp3(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb);
1127 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1128 VdbeComment((v, "%s", pIdx->zName));
1130 /* Implementation of the following:
1132 ** regChng = 0
1133 ** Rewind csr
1134 ** if eof(csr){
1135 ** stat_init() with count = 0;
1136 ** goto end_of_scan;
1137 ** }
1138 ** count()
1139 ** stat_init()
1140 ** goto chng_addr_0;
1142 assert( regTemp2==regStat+4 );
1143 sqlite3VdbeAddOp2(v, OP_Integer, db->nAnalysisLimit, regTemp2);
1145 /* Arguments to stat_init():
1146 ** (1) the number of columns in the index including the rowid
1147 ** (or for a WITHOUT ROWID table, the number of PK columns),
1148 ** (2) the number of columns in the key without the rowid/pk
1149 ** (3) estimated number of rows in the index. */
1150 sqlite3VdbeAddOp2(v, OP_Integer, nCol, regStat+1);
1151 assert( regRowid==regStat+2 );
1152 sqlite3VdbeAddOp2(v, OP_Integer, pIdx->nKeyCol, regRowid);
1153 sqlite3VdbeAddOp3(v, OP_Count, iIdxCur, regTemp,
1154 OptimizationDisabled(db, SQLITE_Stat4));
1155 sqlite3VdbeAddFunctionCall(pParse, 0, regStat+1, regStat, 4,
1156 &statInitFuncdef, 0);
1157 addrGotoEnd = sqlite3VdbeAddOp1(v, OP_Rewind, iIdxCur);
1158 VdbeCoverage(v);
1160 sqlite3VdbeAddOp2(v, OP_Integer, 0, regChng);
1161 addrNextRow = sqlite3VdbeCurrentAddr(v);
1163 if( nColTest>0 ){
1164 int endDistinctTest = sqlite3VdbeMakeLabel(pParse);
1165 int *aGotoChng; /* Array of jump instruction addresses */
1166 aGotoChng = sqlite3DbMallocRawNN(db, sizeof(int)*nColTest);
1167 if( aGotoChng==0 ) continue;
1170 ** next_row:
1171 ** regChng = 0
1172 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1173 ** regChng = 1
1174 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1175 ** ...
1176 ** regChng = N
1177 ** goto endDistinctTest
1179 sqlite3VdbeAddOp0(v, OP_Goto);
1180 addrNextRow = sqlite3VdbeCurrentAddr(v);
1181 if( nColTest==1 && pIdx->nKeyCol==1 && IsUniqueIndex(pIdx) ){
1182 /* For a single-column UNIQUE index, once we have found a non-NULL
1183 ** row, we know that all the rest will be distinct, so skip
1184 ** subsequent distinctness tests. */
1185 sqlite3VdbeAddOp2(v, OP_NotNull, regPrev, endDistinctTest);
1186 VdbeCoverage(v);
1188 for(i=0; i<nColTest; i++){
1189 char *pColl = (char*)sqlite3LocateCollSeq(pParse, pIdx->azColl[i]);
1190 sqlite3VdbeAddOp2(v, OP_Integer, i, regChng);
1191 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regTemp);
1192 analyzeVdbeCommentIndexWithColumnName(v,pIdx,i);
1193 aGotoChng[i] =
1194 sqlite3VdbeAddOp4(v, OP_Ne, regTemp, 0, regPrev+i, pColl, P4_COLLSEQ);
1195 sqlite3VdbeChangeP5(v, SQLITE_NULLEQ);
1196 VdbeCoverage(v);
1198 sqlite3VdbeAddOp2(v, OP_Integer, nColTest, regChng);
1199 sqlite3VdbeGoto(v, endDistinctTest);
1203 ** chng_addr_0:
1204 ** regPrev(0) = idx(0)
1205 ** chng_addr_1:
1206 ** regPrev(1) = idx(1)
1207 ** ...
1209 sqlite3VdbeJumpHere(v, addrNextRow-1);
1210 for(i=0; i<nColTest; i++){
1211 sqlite3VdbeJumpHere(v, aGotoChng[i]);
1212 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regPrev+i);
1213 analyzeVdbeCommentIndexWithColumnName(v,pIdx,i);
1215 sqlite3VdbeResolveLabel(v, endDistinctTest);
1216 sqlite3DbFree(db, aGotoChng);
1220 ** chng_addr_N:
1221 ** regRowid = idx(rowid) // STAT4 only
1222 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT4 only
1223 ** Next csr
1224 ** if !eof(csr) goto next_row;
1226 #ifdef SQLITE_ENABLE_STAT4
1227 if( OptimizationEnabled(db, SQLITE_Stat4) ){
1228 assert( regRowid==(regStat+2) );
1229 if( HasRowid(pTab) ){
1230 sqlite3VdbeAddOp2(v, OP_IdxRowid, iIdxCur, regRowid);
1231 }else{
1232 Index *pPk = sqlite3PrimaryKeyIndex(pIdx->pTable);
1233 int j, k, regKey;
1234 regKey = sqlite3GetTempRange(pParse, pPk->nKeyCol);
1235 for(j=0; j<pPk->nKeyCol; j++){
1236 k = sqlite3TableColumnToIndex(pIdx, pPk->aiColumn[j]);
1237 assert( k>=0 && k<pIdx->nColumn );
1238 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, k, regKey+j);
1239 analyzeVdbeCommentIndexWithColumnName(v,pIdx,k);
1241 sqlite3VdbeAddOp3(v, OP_MakeRecord, regKey, pPk->nKeyCol, regRowid);
1242 sqlite3ReleaseTempRange(pParse, regKey, pPk->nKeyCol);
1245 #endif
1246 assert( regChng==(regStat+1) );
1248 sqlite3VdbeAddFunctionCall(pParse, 1, regStat, regTemp, 2+IsStat4,
1249 &statPushFuncdef, 0);
1250 if( db->nAnalysisLimit ){
1251 int j1, j2, j3;
1252 j1 = sqlite3VdbeAddOp1(v, OP_IsNull, regTemp); VdbeCoverage(v);
1253 j2 = sqlite3VdbeAddOp1(v, OP_If, regTemp); VdbeCoverage(v);
1254 j3 = sqlite3VdbeAddOp4Int(v, OP_SeekGT, iIdxCur, 0, regPrev, 1);
1255 VdbeCoverage(v);
1256 sqlite3VdbeJumpHere(v, j1);
1257 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
1258 sqlite3VdbeJumpHere(v, j2);
1259 sqlite3VdbeJumpHere(v, j3);
1260 }else{
1261 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, addrNextRow); VdbeCoverage(v);
1265 /* Add the entry to the stat1 table. */
1266 if( pIdx->pPartIdxWhere ){
1267 /* Partial indexes might get a zero-entry in sqlite_stat1. But
1268 ** an empty table is omitted from sqlite_stat1. */
1269 sqlite3VdbeJumpHere(v, addrGotoEnd);
1270 addrGotoEnd = 0;
1272 callStatGet(pParse, regStat, STAT_GET_STAT1, regStat1);
1273 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1274 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
1275 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
1276 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
1277 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1278 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1279 #endif
1280 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1282 /* Add the entries to the stat4 table. */
1283 #ifdef SQLITE_ENABLE_STAT4
1284 if( OptimizationEnabled(db, SQLITE_Stat4) && db->nAnalysisLimit==0 ){
1285 int regEq = regStat1;
1286 int regLt = regStat1+1;
1287 int regDLt = regStat1+2;
1288 int regSample = regStat1+3;
1289 int regCol = regStat1+4;
1290 int regSampleRowid = regCol + nCol;
1291 int addrNext;
1292 int addrIsNull;
1293 u8 seekOp = HasRowid(pTab) ? OP_NotExists : OP_NotFound;
1295 /* No STAT4 data is generated if the number of rows is zero */
1296 if( addrGotoEnd==0 ){
1297 sqlite3VdbeAddOp2(v, OP_Cast, regStat1, SQLITE_AFF_INTEGER);
1298 addrGotoEnd = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1);
1299 VdbeCoverage(v);
1302 if( doOnce ){
1303 int mxCol = nCol;
1304 Index *pX;
1306 /* Compute the maximum number of columns in any index */
1307 for(pX=pTab->pIndex; pX; pX=pX->pNext){
1308 int nColX; /* Number of columns in pX */
1309 if( !HasRowid(pTab) && IsPrimaryKeyIndex(pX) ){
1310 nColX = pX->nKeyCol;
1311 }else{
1312 nColX = pX->nColumn;
1314 if( nColX>mxCol ) mxCol = nColX;
1317 /* Allocate space to compute results for the largest index */
1318 sqlite3TouchRegister(pParse, regCol+mxCol);
1319 doOnce = 0;
1320 #ifdef SQLITE_DEBUG
1321 /* Verify that the call to sqlite3ClearTempRegCache() below
1322 ** really is needed.
1323 ** https://sqlite.org/forum/forumpost/83cb4a95a0 (2023-03-25)
1325 testcase( !sqlite3NoTempsInRange(pParse, regEq, regCol+mxCol) );
1326 #endif
1327 sqlite3ClearTempRegCache(pParse); /* tag-20230325-1 */
1328 assert( sqlite3NoTempsInRange(pParse, regEq, regCol+mxCol) );
1330 assert( sqlite3NoTempsInRange(pParse, regEq, regCol+nCol) );
1332 addrNext = sqlite3VdbeCurrentAddr(v);
1333 callStatGet(pParse, regStat, STAT_GET_ROWID, regSampleRowid);
1334 addrIsNull = sqlite3VdbeAddOp1(v, OP_IsNull, regSampleRowid);
1335 VdbeCoverage(v);
1336 callStatGet(pParse, regStat, STAT_GET_NEQ, regEq);
1337 callStatGet(pParse, regStat, STAT_GET_NLT, regLt);
1338 callStatGet(pParse, regStat, STAT_GET_NDLT, regDLt);
1339 sqlite3VdbeAddOp4Int(v, seekOp, iTabCur, addrNext, regSampleRowid, 0);
1340 VdbeCoverage(v);
1341 for(i=0; i<nCol; i++){
1342 sqlite3ExprCodeLoadIndexColumn(pParse, pIdx, iTabCur, i, regCol+i);
1344 sqlite3VdbeAddOp3(v, OP_MakeRecord, regCol, nCol, regSample);
1345 sqlite3VdbeAddOp3(v, OP_MakeRecord, regTabname, 6, regTemp);
1346 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regNewRowid);
1347 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regTemp, regNewRowid);
1348 sqlite3VdbeAddOp2(v, OP_Goto, 1, addrNext); /* P1==1 for end-of-loop */
1349 sqlite3VdbeJumpHere(v, addrIsNull);
1351 #endif /* SQLITE_ENABLE_STAT4 */
1353 /* End of analysis */
1354 if( addrGotoEnd ) sqlite3VdbeJumpHere(v, addrGotoEnd);
1358 /* Create a single sqlite_stat1 entry containing NULL as the index
1359 ** name and the row count as the content.
1361 if( pOnlyIdx==0 && needTableCnt ){
1362 VdbeComment((v, "%s", pTab->zName));
1363 sqlite3VdbeAddOp2(v, OP_Count, iTabCur, regStat1);
1364 jZeroRows = sqlite3VdbeAddOp1(v, OP_IfNot, regStat1); VdbeCoverage(v);
1365 sqlite3VdbeAddOp2(v, OP_Null, 0, regIdxname);
1366 assert( "BBB"[0]==SQLITE_AFF_TEXT );
1367 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regTemp, "BBB", 0);
1368 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regNewRowid);
1369 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regTemp, regNewRowid);
1370 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
1371 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1372 sqlite3VdbeChangeP4(v, -1, (char*)pStat1, P4_TABLE);
1373 #endif
1374 sqlite3VdbeJumpHere(v, jZeroRows);
1380 ** Generate code that will cause the most recent index analysis to
1381 ** be loaded into internal hash tables where is can be used.
1383 static void loadAnalysis(Parse *pParse, int iDb){
1384 Vdbe *v = sqlite3GetVdbe(pParse);
1385 if( v ){
1386 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
1391 ** Generate code that will do an analysis of an entire database
1393 static void analyzeDatabase(Parse *pParse, int iDb){
1394 sqlite3 *db = pParse->db;
1395 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
1396 HashElem *k;
1397 int iStatCur;
1398 int iMem;
1399 int iTab;
1401 sqlite3BeginWriteOperation(pParse, 0, iDb);
1402 iStatCur = pParse->nTab;
1403 pParse->nTab += 3;
1404 openStatTable(pParse, iDb, iStatCur, 0, 0);
1405 iMem = pParse->nMem+1;
1406 iTab = pParse->nTab;
1407 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1408 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1409 Table *pTab = (Table*)sqliteHashData(k);
1410 analyzeOneTable(pParse, pTab, 0, iStatCur, iMem, iTab);
1411 #ifdef SQLITE_ENABLE_STAT4
1412 iMem = sqlite3FirstAvailableRegister(pParse, iMem);
1413 #else
1414 assert( iMem==sqlite3FirstAvailableRegister(pParse,iMem) );
1415 #endif
1417 loadAnalysis(pParse, iDb);
1421 ** Generate code that will do an analysis of a single table in
1422 ** a database. If pOnlyIdx is not NULL then it is a single index
1423 ** in pTab that should be analyzed.
1425 static void analyzeTable(Parse *pParse, Table *pTab, Index *pOnlyIdx){
1426 int iDb;
1427 int iStatCur;
1429 assert( pTab!=0 );
1430 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
1431 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
1432 sqlite3BeginWriteOperation(pParse, 0, iDb);
1433 iStatCur = pParse->nTab;
1434 pParse->nTab += 3;
1435 if( pOnlyIdx ){
1436 openStatTable(pParse, iDb, iStatCur, pOnlyIdx->zName, "idx");
1437 }else{
1438 openStatTable(pParse, iDb, iStatCur, pTab->zName, "tbl");
1440 analyzeOneTable(pParse, pTab, pOnlyIdx, iStatCur,pParse->nMem+1,pParse->nTab);
1441 loadAnalysis(pParse, iDb);
1445 ** Generate code for the ANALYZE command. The parser calls this routine
1446 ** when it recognizes an ANALYZE command.
1448 ** ANALYZE -- 1
1449 ** ANALYZE <database> -- 2
1450 ** ANALYZE ?<database>.?<tablename> -- 3
1452 ** Form 1 causes all indices in all attached databases to be analyzed.
1453 ** Form 2 analyzes all indices the single database named.
1454 ** Form 3 analyzes all indices associated with the named table.
1456 void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
1457 sqlite3 *db = pParse->db;
1458 int iDb;
1459 int i;
1460 char *z, *zDb;
1461 Table *pTab;
1462 Index *pIdx;
1463 Token *pTableName;
1464 Vdbe *v;
1466 /* Read the database schema. If an error occurs, leave an error message
1467 ** and code in pParse and return NULL. */
1468 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
1469 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
1470 return;
1473 assert( pName2!=0 || pName1==0 );
1474 if( pName1==0 ){
1475 /* Form 1: Analyze everything */
1476 for(i=0; i<db->nDb; i++){
1477 if( i==1 ) continue; /* Do not analyze the TEMP database */
1478 analyzeDatabase(pParse, i);
1480 }else if( pName2->n==0 && (iDb = sqlite3FindDb(db, pName1))>=0 ){
1481 /* Analyze the schema named as the argument */
1482 analyzeDatabase(pParse, iDb);
1483 }else{
1484 /* Form 3: Analyze the table or index named as an argument */
1485 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
1486 if( iDb>=0 ){
1487 zDb = pName2->n ? db->aDb[iDb].zDbSName : 0;
1488 z = sqlite3NameFromToken(db, pTableName);
1489 if( z ){
1490 if( (pIdx = sqlite3FindIndex(db, z, zDb))!=0 ){
1491 analyzeTable(pParse, pIdx->pTable, pIdx);
1492 }else if( (pTab = sqlite3LocateTable(pParse, 0, z, zDb))!=0 ){
1493 analyzeTable(pParse, pTab, 0);
1495 sqlite3DbFree(db, z);
1499 if( db->nSqlExec==0 && (v = sqlite3GetVdbe(pParse))!=0 ){
1500 sqlite3VdbeAddOp0(v, OP_Expire);
1505 ** Used to pass information from the analyzer reader through to the
1506 ** callback routine.
1508 typedef struct analysisInfo analysisInfo;
1509 struct analysisInfo {
1510 sqlite3 *db;
1511 const char *zDatabase;
1515 ** The first argument points to a nul-terminated string containing a
1516 ** list of space separated integers. Read the first nOut of these into
1517 ** the array aOut[].
1519 static void decodeIntArray(
1520 char *zIntArray, /* String containing int array to decode */
1521 int nOut, /* Number of slots in aOut[] */
1522 tRowcnt *aOut, /* Store integers here */
1523 LogEst *aLog, /* Or, if aOut==0, here */
1524 Index *pIndex /* Handle extra flags for this index, if not NULL */
1526 char *z = zIntArray;
1527 int c;
1528 int i;
1529 tRowcnt v;
1531 #ifdef SQLITE_ENABLE_STAT4
1532 if( z==0 ) z = "";
1533 #else
1534 assert( z!=0 );
1535 #endif
1536 for(i=0; *z && i<nOut; i++){
1537 v = 0;
1538 while( (c=z[0])>='0' && c<='9' ){
1539 v = v*10 + c - '0';
1540 z++;
1542 #ifdef SQLITE_ENABLE_STAT4
1543 if( aOut ) aOut[i] = v;
1544 if( aLog ) aLog[i] = sqlite3LogEst(v);
1545 #else
1546 assert( aOut==0 );
1547 UNUSED_PARAMETER(aOut);
1548 assert( aLog!=0 );
1549 aLog[i] = sqlite3LogEst(v);
1550 #endif
1551 if( *z==' ' ) z++;
1553 #ifndef SQLITE_ENABLE_STAT4
1554 assert( pIndex!=0 ); {
1555 #else
1556 if( pIndex ){
1557 #endif
1558 pIndex->bUnordered = 0;
1559 pIndex->noSkipScan = 0;
1560 while( z[0] ){
1561 if( sqlite3_strglob("unordered*", z)==0 ){
1562 pIndex->bUnordered = 1;
1563 }else if( sqlite3_strglob("sz=[0-9]*", z)==0 ){
1564 int sz = sqlite3Atoi(z+3);
1565 if( sz<2 ) sz = 2;
1566 pIndex->szIdxRow = sqlite3LogEst(sz);
1567 }else if( sqlite3_strglob("noskipscan*", z)==0 ){
1568 pIndex->noSkipScan = 1;
1570 #ifdef SQLITE_ENABLE_COSTMULT
1571 else if( sqlite3_strglob("costmult=[0-9]*",z)==0 ){
1572 pIndex->pTable->costMult = sqlite3LogEst(sqlite3Atoi(z+9));
1574 #endif
1575 while( z[0]!=0 && z[0]!=' ' ) z++;
1576 while( z[0]==' ' ) z++;
1579 /* Set the bLowQual flag if the peak number of rows obtained
1580 ** from a full equality match is so large that a full table scan
1581 ** seems likely to be faster than using the index.
1583 if( aLog[0] > 66 /* Index has more than 100 rows */
1584 && aLog[0] <= aLog[nOut-1] /* And only a single value seen */
1586 pIndex->bLowQual = 1;
1592 ** This callback is invoked once for each index when reading the
1593 ** sqlite_stat1 table.
1595 ** argv[0] = name of the table
1596 ** argv[1] = name of the index (might be NULL)
1597 ** argv[2] = results of analysis - on integer for each column
1599 ** Entries for which argv[1]==NULL simply record the number of rows in
1600 ** the table.
1602 static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
1603 analysisInfo *pInfo = (analysisInfo*)pData;
1604 Index *pIndex;
1605 Table *pTable;
1606 const char *z;
1608 assert( argc==3 );
1609 UNUSED_PARAMETER2(NotUsed, argc);
1611 if( argv==0 || argv[0]==0 || argv[2]==0 ){
1612 return 0;
1614 pTable = sqlite3FindTable(pInfo->db, argv[0], pInfo->zDatabase);
1615 if( pTable==0 ){
1616 return 0;
1618 if( argv[1]==0 ){
1619 pIndex = 0;
1620 }else if( sqlite3_stricmp(argv[0],argv[1])==0 ){
1621 pIndex = sqlite3PrimaryKeyIndex(pTable);
1622 }else{
1623 pIndex = sqlite3FindIndex(pInfo->db, argv[1], pInfo->zDatabase);
1625 z = argv[2];
1627 if( pIndex ){
1628 tRowcnt *aiRowEst = 0;
1629 int nCol = pIndex->nKeyCol+1;
1630 #ifdef SQLITE_ENABLE_STAT4
1631 /* Index.aiRowEst may already be set here if there are duplicate
1632 ** sqlite_stat1 entries for this index. In that case just clobber
1633 ** the old data with the new instead of allocating a new array. */
1634 if( pIndex->aiRowEst==0 ){
1635 pIndex->aiRowEst = (tRowcnt*)sqlite3MallocZero(sizeof(tRowcnt) * nCol);
1636 if( pIndex->aiRowEst==0 ) sqlite3OomFault(pInfo->db);
1638 aiRowEst = pIndex->aiRowEst;
1639 #endif
1640 pIndex->bUnordered = 0;
1641 decodeIntArray((char*)z, nCol, aiRowEst, pIndex->aiRowLogEst, pIndex);
1642 pIndex->hasStat1 = 1;
1643 if( pIndex->pPartIdxWhere==0 ){
1644 pTable->nRowLogEst = pIndex->aiRowLogEst[0];
1645 pTable->tabFlags |= TF_HasStat1;
1647 }else{
1648 Index fakeIdx;
1649 fakeIdx.szIdxRow = pTable->szTabRow;
1650 #ifdef SQLITE_ENABLE_COSTMULT
1651 fakeIdx.pTable = pTable;
1652 #endif
1653 decodeIntArray((char*)z, 1, 0, &pTable->nRowLogEst, &fakeIdx);
1654 pTable->szTabRow = fakeIdx.szIdxRow;
1655 pTable->tabFlags |= TF_HasStat1;
1658 return 0;
1662 ** If the Index.aSample variable is not NULL, delete the aSample[] array
1663 ** and its contents.
1665 void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
1666 assert( db!=0 );
1667 assert( pIdx!=0 );
1668 #ifdef SQLITE_ENABLE_STAT4
1669 if( pIdx->aSample ){
1670 int j;
1671 for(j=0; j<pIdx->nSample; j++){
1672 IndexSample *p = &pIdx->aSample[j];
1673 sqlite3DbFree(db, p->p);
1675 sqlite3DbFree(db, pIdx->aSample);
1677 if( db->pnBytesFreed==0 ){
1678 pIdx->nSample = 0;
1679 pIdx->aSample = 0;
1681 #else
1682 UNUSED_PARAMETER(db);
1683 UNUSED_PARAMETER(pIdx);
1684 #endif /* SQLITE_ENABLE_STAT4 */
1687 #ifdef SQLITE_ENABLE_STAT4
1689 ** Populate the pIdx->aAvgEq[] array based on the samples currently
1690 ** stored in pIdx->aSample[].
1692 static void initAvgEq(Index *pIdx){
1693 if( pIdx ){
1694 IndexSample *aSample = pIdx->aSample;
1695 IndexSample *pFinal = &aSample[pIdx->nSample-1];
1696 int iCol;
1697 int nCol = 1;
1698 if( pIdx->nSampleCol>1 ){
1699 /* If this is stat4 data, then calculate aAvgEq[] values for all
1700 ** sample columns except the last. The last is always set to 1, as
1701 ** once the trailing PK fields are considered all index keys are
1702 ** unique. */
1703 nCol = pIdx->nSampleCol-1;
1704 pIdx->aAvgEq[nCol] = 1;
1706 for(iCol=0; iCol<nCol; iCol++){
1707 int nSample = pIdx->nSample;
1708 int i; /* Used to iterate through samples */
1709 tRowcnt sumEq = 0; /* Sum of the nEq values */
1710 tRowcnt avgEq = 0;
1711 tRowcnt nRow; /* Number of rows in index */
1712 i64 nSum100 = 0; /* Number of terms contributing to sumEq */
1713 i64 nDist100; /* Number of distinct values in index */
1715 if( !pIdx->aiRowEst || iCol>=pIdx->nKeyCol || pIdx->aiRowEst[iCol+1]==0 ){
1716 nRow = pFinal->anLt[iCol];
1717 nDist100 = (i64)100 * pFinal->anDLt[iCol];
1718 nSample--;
1719 }else{
1720 nRow = pIdx->aiRowEst[0];
1721 nDist100 = ((i64)100 * pIdx->aiRowEst[0]) / pIdx->aiRowEst[iCol+1];
1723 pIdx->nRowEst0 = nRow;
1725 /* Set nSum to the number of distinct (iCol+1) field prefixes that
1726 ** occur in the stat4 table for this index. Set sumEq to the sum of
1727 ** the nEq values for column iCol for the same set (adding the value
1728 ** only once where there exist duplicate prefixes). */
1729 for(i=0; i<nSample; i++){
1730 if( i==(pIdx->nSample-1)
1731 || aSample[i].anDLt[iCol]!=aSample[i+1].anDLt[iCol]
1733 sumEq += aSample[i].anEq[iCol];
1734 nSum100 += 100;
1738 if( nDist100>nSum100 && sumEq<nRow ){
1739 avgEq = ((i64)100 * (nRow - sumEq))/(nDist100 - nSum100);
1741 if( avgEq==0 ) avgEq = 1;
1742 pIdx->aAvgEq[iCol] = avgEq;
1748 ** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1749 ** is supplied instead, find the PRIMARY KEY index for that table.
1751 static Index *findIndexOrPrimaryKey(
1752 sqlite3 *db,
1753 const char *zName,
1754 const char *zDb
1756 Index *pIdx = sqlite3FindIndex(db, zName, zDb);
1757 if( pIdx==0 ){
1758 Table *pTab = sqlite3FindTable(db, zName, zDb);
1759 if( pTab && !HasRowid(pTab) ) pIdx = sqlite3PrimaryKeyIndex(pTab);
1761 return pIdx;
1765 ** Load the content from either the sqlite_stat4
1766 ** into the relevant Index.aSample[] arrays.
1768 ** Arguments zSql1 and zSql2 must point to SQL statements that return
1769 ** data equivalent to the following:
1771 ** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1772 ** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1774 ** where %Q is replaced with the database name before the SQL is executed.
1776 static int loadStatTbl(
1777 sqlite3 *db, /* Database handle */
1778 const char *zSql1, /* SQL statement 1 (see above) */
1779 const char *zSql2, /* SQL statement 2 (see above) */
1780 const char *zDb /* Database name (e.g. "main") */
1782 int rc; /* Result codes from subroutines */
1783 sqlite3_stmt *pStmt = 0; /* An SQL statement being run */
1784 char *zSql; /* Text of the SQL statement */
1785 Index *pPrevIdx = 0; /* Previous index in the loop */
1786 IndexSample *pSample; /* A slot in pIdx->aSample[] */
1788 assert( db->lookaside.bDisable );
1789 zSql = sqlite3MPrintf(db, zSql1, zDb);
1790 if( !zSql ){
1791 return SQLITE_NOMEM_BKPT;
1793 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1794 sqlite3DbFree(db, zSql);
1795 if( rc ) return rc;
1797 while( sqlite3_step(pStmt)==SQLITE_ROW ){
1798 int nIdxCol = 1; /* Number of columns in stat4 records */
1800 char *zIndex; /* Index name */
1801 Index *pIdx; /* Pointer to the index object */
1802 int nSample; /* Number of samples */
1803 int nByte; /* Bytes of space required */
1804 int i; /* Bytes of space required */
1805 tRowcnt *pSpace;
1807 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1808 if( zIndex==0 ) continue;
1809 nSample = sqlite3_column_int(pStmt, 1);
1810 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
1811 assert( pIdx==0 || pIdx->nSample==0 );
1812 if( pIdx==0 ) continue;
1813 if( pIdx->aSample!=0 ){
1814 /* The same index appears in sqlite_stat4 under multiple names */
1815 continue;
1817 assert( !HasRowid(pIdx->pTable) || pIdx->nColumn==pIdx->nKeyCol+1 );
1818 if( !HasRowid(pIdx->pTable) && IsPrimaryKeyIndex(pIdx) ){
1819 nIdxCol = pIdx->nKeyCol;
1820 }else{
1821 nIdxCol = pIdx->nColumn;
1823 pIdx->nSampleCol = nIdxCol;
1824 pIdx->mxSample = nSample;
1825 nByte = sizeof(IndexSample) * nSample;
1826 nByte += sizeof(tRowcnt) * nIdxCol * 3 * nSample;
1827 nByte += nIdxCol * sizeof(tRowcnt); /* Space for Index.aAvgEq[] */
1829 pIdx->aSample = sqlite3DbMallocZero(db, nByte);
1830 if( pIdx->aSample==0 ){
1831 sqlite3_finalize(pStmt);
1832 return SQLITE_NOMEM_BKPT;
1834 pSpace = (tRowcnt*)&pIdx->aSample[nSample];
1835 pIdx->aAvgEq = pSpace; pSpace += nIdxCol;
1836 pIdx->pTable->tabFlags |= TF_HasStat4;
1837 for(i=0; i<nSample; i++){
1838 pIdx->aSample[i].anEq = pSpace; pSpace += nIdxCol;
1839 pIdx->aSample[i].anLt = pSpace; pSpace += nIdxCol;
1840 pIdx->aSample[i].anDLt = pSpace; pSpace += nIdxCol;
1842 assert( ((u8*)pSpace)-nByte==(u8*)(pIdx->aSample) );
1844 rc = sqlite3_finalize(pStmt);
1845 if( rc ) return rc;
1847 zSql = sqlite3MPrintf(db, zSql2, zDb);
1848 if( !zSql ){
1849 return SQLITE_NOMEM_BKPT;
1851 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
1852 sqlite3DbFree(db, zSql);
1853 if( rc ) return rc;
1855 while( sqlite3_step(pStmt)==SQLITE_ROW ){
1856 char *zIndex; /* Index name */
1857 Index *pIdx; /* Pointer to the index object */
1858 int nCol = 1; /* Number of columns in index */
1860 zIndex = (char *)sqlite3_column_text(pStmt, 0);
1861 if( zIndex==0 ) continue;
1862 pIdx = findIndexOrPrimaryKey(db, zIndex, zDb);
1863 if( pIdx==0 ) continue;
1864 if( pIdx->nSample>=pIdx->mxSample ){
1865 /* Too many slots used because the same index appears in
1866 ** sqlite_stat4 using multiple names */
1867 continue;
1869 /* This next condition is true if data has already been loaded from
1870 ** the sqlite_stat4 table. */
1871 nCol = pIdx->nSampleCol;
1872 if( pIdx!=pPrevIdx ){
1873 initAvgEq(pPrevIdx);
1874 pPrevIdx = pIdx;
1876 pSample = &pIdx->aSample[pIdx->nSample];
1877 decodeIntArray((char*)sqlite3_column_text(pStmt,1),nCol,pSample->anEq,0,0);
1878 decodeIntArray((char*)sqlite3_column_text(pStmt,2),nCol,pSample->anLt,0,0);
1879 decodeIntArray((char*)sqlite3_column_text(pStmt,3),nCol,pSample->anDLt,0,0);
1881 /* Take a copy of the sample. Add 8 extra 0x00 bytes the end of the buffer.
1882 ** This is in case the sample record is corrupted. In that case, the
1883 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1884 ** end of the allocated buffer before it realizes it is dealing with
1885 ** a corrupt record. Or it might try to read a large integer from the
1886 ** buffer. In any case, eight 0x00 bytes prevents this from causing
1887 ** a buffer overread. */
1888 pSample->n = sqlite3_column_bytes(pStmt, 4);
1889 pSample->p = sqlite3DbMallocZero(db, pSample->n + 8);
1890 if( pSample->p==0 ){
1891 sqlite3_finalize(pStmt);
1892 return SQLITE_NOMEM_BKPT;
1894 if( pSample->n ){
1895 memcpy(pSample->p, sqlite3_column_blob(pStmt, 4), pSample->n);
1897 pIdx->nSample++;
1899 rc = sqlite3_finalize(pStmt);
1900 if( rc==SQLITE_OK ) initAvgEq(pPrevIdx);
1901 return rc;
1905 ** Load content from the sqlite_stat4 table into
1906 ** the Index.aSample[] arrays of all indices.
1908 static int loadStat4(sqlite3 *db, const char *zDb){
1909 int rc = SQLITE_OK; /* Result codes from subroutines */
1910 const Table *pStat4;
1912 assert( db->lookaside.bDisable );
1913 if( OptimizationEnabled(db, SQLITE_Stat4)
1914 && (pStat4 = sqlite3FindTable(db, "sqlite_stat4", zDb))!=0
1915 && IsOrdinaryTable(pStat4)
1917 rc = loadStatTbl(db,
1918 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx COLLATE nocase",
1919 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1923 return rc;
1925 #endif /* SQLITE_ENABLE_STAT4 */
1928 ** Load the content of the sqlite_stat1 and sqlite_stat4 tables. The
1929 ** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
1930 ** arrays. The contents of sqlite_stat4 are used to populate the
1931 ** Index.aSample[] arrays.
1933 ** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
1934 ** is returned. In this case, even if SQLITE_ENABLE_STAT4 was defined
1935 ** during compilation and the sqlite_stat4 table is present, no data is
1936 ** read from it.
1938 ** If SQLITE_ENABLE_STAT4 was defined during compilation and the
1939 ** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
1940 ** returned. However, in this case, data is read from the sqlite_stat1
1941 ** table (if it is present) before returning.
1943 ** If an OOM error occurs, this function always sets db->mallocFailed.
1944 ** This means if the caller does not care about other errors, the return
1945 ** code may be ignored.
1947 int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
1948 analysisInfo sInfo;
1949 HashElem *i;
1950 char *zSql;
1951 int rc = SQLITE_OK;
1952 Schema *pSchema = db->aDb[iDb].pSchema;
1953 const Table *pStat1;
1955 assert( iDb>=0 && iDb<db->nDb );
1956 assert( db->aDb[iDb].pBt!=0 );
1958 /* Clear any prior statistics */
1959 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1960 for(i=sqliteHashFirst(&pSchema->tblHash); i; i=sqliteHashNext(i)){
1961 Table *pTab = sqliteHashData(i);
1962 pTab->tabFlags &= ~TF_HasStat1;
1964 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
1965 Index *pIdx = sqliteHashData(i);
1966 pIdx->hasStat1 = 0;
1967 #ifdef SQLITE_ENABLE_STAT4
1968 sqlite3DeleteIndexSamples(db, pIdx);
1969 pIdx->aSample = 0;
1970 #endif
1973 /* Load new statistics out of the sqlite_stat1 table */
1974 sInfo.db = db;
1975 sInfo.zDatabase = db->aDb[iDb].zDbSName;
1976 if( (pStat1 = sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase))
1977 && IsOrdinaryTable(pStat1)
1979 zSql = sqlite3MPrintf(db,
1980 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
1981 if( zSql==0 ){
1982 rc = SQLITE_NOMEM_BKPT;
1983 }else{
1984 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
1985 sqlite3DbFree(db, zSql);
1989 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1990 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
1991 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
1992 Index *pIdx = sqliteHashData(i);
1993 if( !pIdx->hasStat1 ) sqlite3DefaultRowEst(pIdx);
1996 /* Load the statistics from the sqlite_stat4 table. */
1997 #ifdef SQLITE_ENABLE_STAT4
1998 if( rc==SQLITE_OK ){
1999 DisableLookaside;
2000 rc = loadStat4(db, sInfo.zDatabase);
2001 EnableLookaside;
2003 for(i=sqliteHashFirst(&pSchema->idxHash); i; i=sqliteHashNext(i)){
2004 Index *pIdx = sqliteHashData(i);
2005 sqlite3_free(pIdx->aiRowEst);
2006 pIdx->aiRowEst = 0;
2008 #endif
2010 if( rc==SQLITE_NOMEM ){
2011 sqlite3OomFault(db);
2013 return rc;
2017 #endif /* SQLITE_OMIT_ANALYZE */