4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
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
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.
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
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
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
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
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)
149 # undef SQLITE_STAT4_SAMPLES
150 # define SQLITE_STAT4_SAMPLES 1
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 {
177 { "sqlite_stat1", "tbl,idx,stat" },
178 #if defined(SQLITE_ENABLE_STAT4)
179 { "sqlite_stat4", "tbl,idx,neq,nlt,ndlt,sample" },
181 { "sqlite_stat4", 0 },
183 { "sqlite_stat3", 0 },
186 sqlite3
*db
= pParse
->db
;
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;
194 const int nToOpen
= 1;
198 assert( sqlite3BtreeHoldsAllMutexes(db
) );
199 assert( sqlite3VdbeDb(v
)==db
);
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
;
209 if( (pStat
= sqlite3FindTable(db
, zTab
, pDb
->zDbSName
))==0 ){
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
;
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
);
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
);
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
260 ** Three SQL functions - stat_init(), stat_push(), and stat_get() -
261 ** share an instance of the following structure to hold their state
264 typedef struct StatAccum StatAccum
;
265 typedef struct StatSample StatSample
;
267 tRowcnt
*anEq
; /* sqlite_stat4.nEq */
268 tRowcnt
*anDLt
; /* sqlite_stat4.nDLt */
269 #ifdef SQLITE_ENABLE_STAT4
270 tRowcnt
*anLt
; /* sqlite_stat4.nLt */
272 i64 iRowid
; /* Rowid in main table of the key */
273 u8
*aRowid
; /* Key for WITHOUT ROWID tables */
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 */
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 */
303 /* Reclaim memory used by a StatSample
305 #ifdef SQLITE_ENABLE_STAT4
306 static void sampleClear(sqlite3
*db
, StatSample
*p
){
309 sqlite3DbFree(db
, p
->u
.aRowid
);
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
){
320 if( p
->nRowid
) sqlite3DbFree(db
, p
->u
.aRowid
);
321 p
->u
.aRowid
= sqlite3DbMallocRawNN(db
, n
);
324 memcpy(p
->u
.aRowid
, pData
, n
);
331 /* Initialize the INTEGER value of a ROWID.
333 #ifdef SQLITE_ENABLE_STAT4
334 static void sampleSetRowidInt64(sqlite3
*db
, StatSample
*p
, i64 iRowid
){
336 if( p
->nRowid
) sqlite3DbFree(db
, p
->u
.aRowid
);
338 p
->u
.iRowid
= iRowid
;
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
);
355 sampleSetRowid(p
->db
, pTo
, pFrom
->nRowid
, pFrom
->u
.aRowid
);
357 sampleSetRowidInt64(p
->db
, pTo
, pFrom
->u
.iRowid
);
363 ** Reclaim all memory of a StatAccum structure.
365 static void statAccumDestructor(void *pOld
){
366 StatAccum
*p
= (StatAccum
*)pOld
;
367 #ifdef SQLITE_ENABLE_STAT4
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
);
375 sqlite3DbFree(p
->db
, p
);
379 ** Implementation of the stat_init(N,K,C,L) SQL function. The four parameters
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
400 static void statInit(
401 sqlite3_context
*context
,
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;
416 /* Decode the three function arguments */
417 UNUSED_PARAMETER(argc
);
418 nCol
= sqlite3_value_int(argv
[0]);
420 nColUp
= sizeof(tRowcnt
)<8 ? (nCol
+1)&~1 : nCol
;
421 nKeyCol
= sqlite3_value_int(argv
[1]);
422 assert( nKeyCol
<=nCol
);
425 /* Allocate the space required for the StatAccum object */
427 + sizeof(tRowcnt
)*nColUp
/* StatAccum.anEq */
428 + sizeof(tRowcnt
)*nColUp
; /* StatAccum.anDLt */
429 #ifdef SQLITE_ENABLE_STAT4
431 n
+= sizeof(tRowcnt
)*nColUp
/* StatAccum.anLt */
432 + sizeof(StatSample
)*(nCol
+mxSample
) /* StatAccum.aBest[], a[] */
433 + sizeof(tRowcnt
)*3*nColUp
*(nCol
+mxSample
);
436 p
= sqlite3DbMallocZero(db
, n
);
438 sqlite3_result_error_nomem(context
);
443 p
->nEst
= sqlite3_value_int64(argv
[2]);
445 p
->nLimit
= sqlite3_value_int64(argv
[3]);
447 p
->nKeyCol
= nKeyCol
;
449 p
->current
.anDLt
= (tRowcnt
*)&p
[1];
450 p
->current
.anEq
= &p
->current
.anDLt
[nColUp
];
452 #ifdef SQLITE_ENABLE_STAT4
453 p
->mxSample
= p
->nLimit
==0 ? mxSample
: 0;
455 u8
*pSpace
; /* Allocated space not yet assigned */
456 int i
; /* Used to iterate through p->aSample[] */
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
;
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
484 sqlite3_result_blob(context
, p
, sizeof(*p
), statAccumDestructor
);
486 static const FuncDef statInitFuncdef
= {
488 SQLITE_UTF8
, /* funcFlags */
491 statInit
, /* xSFunc */
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(
515 int nCol
= pAccum
->nCol
;
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;
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(
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
));
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;
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
) ){
591 pUpgrade
->iCol
= pNew
->iCol
;
592 pUpgrade
->anEq
[pUpgrade
->iCol
] = pNew
->anEq
[pUpgrade
->iCol
];
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];
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
);
624 /* Zero the first nEqZero entries in the anEq[] array. */
625 memset(pSample
->anEq
, 0, sizeof(tRowcnt
)*nEqZero
);
628 if( p
->nSample
>=p
->mxSample
){
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
]) ){
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
){
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
--){
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
--){
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)
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
,
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
);
715 assert( iChng
<p
->nCol
);
718 /* This is the first call to this function. Do initialization. */
719 for(i
=0; i
<p
->nCol
; i
++) p
->current
.anEq
[i
] = 1;
721 /* Second and subsequent calls get processed here */
722 #ifdef SQLITE_ENABLE_STAT4
723 if( p
->mxSample
) samplePushPrevious(p
, iChng
);
726 /* Update anDLt[], anLt[] and anEq[] to reflect the values that apply
727 ** to the current row of the index. */
728 for(i
=0; i
<iChng
; i
++){
729 p
->current
.anEq
[i
]++;
731 for(i
=iChng
; i
<p
->nCol
; i
++){
732 p
->current
.anDLt
[i
]++;
733 #ifdef SQLITE_ENABLE_STAT4
734 if( p
->mxSample
) p
->current
.anLt
[i
] += p
->current
.anEq
[i
];
736 p
->current
.anEq
[i
] = 1;
741 #ifdef SQLITE_ENABLE_STAT4
744 if( sqlite3_value_type(argv
[2])==SQLITE_INTEGER
){
745 sampleSetRowidInt64(p
->db
, &p
->current
, sqlite3_value_int64(argv
[2]));
747 sampleSetRowid(p
->db
, &p
->current
, sqlite3_value_bytes(argv
[2]),
748 sqlite3_value_blob(argv
[2]));
750 p
->current
.iHash
= p
->iPrn
= p
->iPrn
*1103515245 + 12345;
752 nLt
= p
->current
.anLt
[p
->nCol
-1];
753 /* Check if this is to be a periodic sample. If so, add it. */
754 if( (nLt
/p
->nPSample
)!=(nLt
+1)/p
->nPSample
){
755 p
->current
.isPSample
= 1;
757 sampleInsert(p
, &p
->current
, p
->nCol
-1);
758 p
->current
.isPSample
= 0;
761 /* Update the aBest[] array. */
762 for(i
=0; i
<(p
->nCol
-1); i
++){
764 if( i
>=iChng
|| sampleIsBetterPost(p
, &p
->current
, &p
->aBest
[i
]) ){
765 sampleCopy(p
, &p
->aBest
[i
], &p
->current
);
770 if( p
->nLimit
&& p
->nRow
>(tRowcnt
)p
->nLimit
*(p
->nSkipAhead
+1) ){
772 sqlite3_result_int(context
, p
->current
.anDLt
[0]>0);
776 static const FuncDef statPushFuncdef
= {
777 2+IsStat4
, /* nArg */
778 SQLITE_UTF8
, /* funcFlags */
781 statPush
, /* xSFunc */
783 0, 0, /* xValue, xInverse */
784 "stat_push", /* zName */
788 #define STAT_GET_STAT1 0 /* "stat" column of stat1 table */
789 #define STAT_GET_ROWID 1 /* "rowid" column of stat[34] entry */
790 #define STAT_GET_NEQ 2 /* "neq" column of stat[34] entry */
791 #define STAT_GET_NLT 3 /* "nlt" column of stat[34] entry */
792 #define STAT_GET_NDLT 4 /* "ndlt" column of stat[34] entry */
795 ** Implementation of the stat_get(P,J) SQL function. This routine is
796 ** used to query statistical information that has been gathered into
797 ** the StatAccum object by prior calls to stat_push(). The P parameter
798 ** has type BLOB but it is really just a pointer to the StatAccum object.
799 ** The content to returned is determined by the parameter J
800 ** which is one of the STAT_GET_xxxx values defined above.
802 ** The stat_get(P,J) function is not available to generic SQL. It is
803 ** inserted as part of a manually constructed bytecode program. (See
804 ** the callStatGet() routine below.) It is guaranteed that the P
805 ** parameter will always be a pointer to a StatAccum object, never a
808 ** If STAT4 is not enabled, then J is always
809 ** STAT_GET_STAT1 and is hence omitted and this routine becomes
810 ** a one-parameter function, stat_get(P), that always returns the
811 ** stat1 table entry information.
814 sqlite3_context
*context
,
818 StatAccum
*p
= (StatAccum
*)sqlite3_value_blob(argv
[0]);
819 #ifdef SQLITE_ENABLE_STAT4
820 /* STAT4 has a parameter on this routine. */
821 int eCall
= sqlite3_value_int(argv
[1]);
823 assert( eCall
==STAT_GET_STAT1
|| eCall
==STAT_GET_NEQ
824 || eCall
==STAT_GET_ROWID
|| eCall
==STAT_GET_NLT
825 || eCall
==STAT_GET_NDLT
827 assert( eCall
==STAT_GET_STAT1
|| p
->mxSample
);
828 if( eCall
==STAT_GET_STAT1
)
833 /* Return the value to store in the "stat" column of the sqlite_stat1
834 ** table for this index.
836 ** The value is a string composed of a list of integers describing
837 ** the index. The first integer in the list is the total number of
838 ** entries in the index. There is one additional integer in the list
839 ** for each indexed column. This additional integer is an estimate of
840 ** the number of rows matched by a equality query on the index using
841 ** a key with the corresponding number of fields. In other words,
842 ** if the index is on columns (a,b) and the sqlite_stat1 value is
843 ** "100 10 2", then SQLite estimates that:
845 ** * the index contains 100 rows,
846 ** * "WHERE a=?" matches 10 rows, and
847 ** * "WHERE a=? AND b=?" matches 2 rows.
849 ** If D is the count of distinct values and K is the total number of
850 ** rows, then each estimate is usually computed as:
854 ** In other words, I is K/D rounded up to the next whole integer.
855 ** However, if I is between 1.0 and 1.1 (in other words if I is
856 ** close to 1.0 but just a little larger) then do not round up but
857 ** instead keep the I value at 1.0.
859 sqlite3_str sStat
; /* Text of the constructed "stat" line */
860 int i
; /* Loop counter */
862 sqlite3StrAccumInit(&sStat
, 0, 0, 0, (p
->nKeyCol
+1)*100);
863 sqlite3_str_appendf(&sStat
, "%llu",
864 p
->nSkipAhead
? (u64
)p
->nEst
: (u64
)p
->nRow
);
865 for(i
=0; i
<p
->nKeyCol
; i
++){
866 u64 nDistinct
= p
->current
.anDLt
[i
] + 1;
867 u64 iVal
= (p
->nRow
+ nDistinct
- 1) / nDistinct
;
868 if( iVal
==2 && p
->nRow
*10 <= nDistinct
*11 ) iVal
= 1;
869 sqlite3_str_appendf(&sStat
, " %llu", iVal
);
870 assert( p
->current
.anEq
[i
] );
872 sqlite3ResultStrAccum(context
, &sStat
);
874 #ifdef SQLITE_ENABLE_STAT4
875 else if( eCall
==STAT_GET_ROWID
){
877 samplePushPrevious(p
, 0);
880 if( p
->iGet
<p
->nSample
){
881 StatSample
*pS
= p
->a
+ p
->iGet
;
883 sqlite3_result_int64(context
, pS
->u
.iRowid
);
885 sqlite3_result_blob(context
, pS
->u
.aRowid
, pS
->nRowid
,
894 assert( p
->iGet
<p
->nSample
);
896 case STAT_GET_NEQ
: aCnt
= p
->a
[p
->iGet
].anEq
; break;
897 case STAT_GET_NLT
: aCnt
= p
->a
[p
->iGet
].anLt
; break;
899 aCnt
= p
->a
[p
->iGet
].anDLt
;
904 sqlite3StrAccumInit(&sStat
, 0, 0, 0, p
->nCol
*100);
905 for(i
=0; i
<p
->nCol
; i
++){
906 sqlite3_str_appendf(&sStat
, "%llu ", (u64
)aCnt
[i
]);
908 if( sStat
.nChar
) sStat
.nChar
--;
909 sqlite3ResultStrAccum(context
, &sStat
);
911 #endif /* SQLITE_ENABLE_STAT4 */
913 UNUSED_PARAMETER( argc
);
916 static const FuncDef statGetFuncdef
= {
917 1+IsStat4
, /* nArg */
918 SQLITE_UTF8
, /* funcFlags */
921 statGet
, /* xSFunc */
923 0, 0, /* xValue, xInverse */
924 "stat_get", /* zName */
928 static void callStatGet(Parse
*pParse
, int regStat
, int iParam
, int regOut
){
929 #ifdef SQLITE_ENABLE_STAT4
930 sqlite3VdbeAddOp2(pParse
->pVdbe
, OP_Integer
, iParam
, regStat
+1);
932 assert( iParam
==STAT_GET_STAT1
);
934 UNUSED_PARAMETER( iParam
);
936 assert( regOut
!=regStat
&& regOut
!=regStat
+1 );
937 sqlite3VdbeAddFunctionCall(pParse
, 0, regStat
, regOut
, 1+IsStat4
,
941 #ifdef SQLITE_ENABLE_EXPLAIN_COMMENTS
942 /* Add a comment to the most recent VDBE opcode that is the name
943 ** of the k-th column of the pIdx index.
945 static void analyzeVdbeCommentIndexWithColumnName(
946 Vdbe
*v
, /* Prepared statement under construction */
947 Index
*pIdx
, /* Index whose column is being loaded */
948 int k
/* Which column index */
950 int i
; /* Index of column in the table */
951 assert( k
>=0 && k
<pIdx
->nColumn
);
952 i
= pIdx
->aiColumn
[k
];
953 if( NEVER(i
==XN_ROWID
) ){
954 VdbeComment((v
,"%s.rowid",pIdx
->zName
));
955 }else if( i
==XN_EXPR
){
956 assert( pIdx
->bHasExpr
);
957 VdbeComment((v
,"%s.expr(%d)",pIdx
->zName
, k
));
959 VdbeComment((v
,"%s.%s", pIdx
->zName
, pIdx
->pTable
->aCol
[i
].zCnName
));
963 # define analyzeVdbeCommentIndexWithColumnName(a,b,c)
964 #endif /* SQLITE_DEBUG */
967 ** Generate code to do an analysis of all indices associated with
970 static void analyzeOneTable(
971 Parse
*pParse
, /* Parser context */
972 Table
*pTab
, /* Table whose indices are to be analyzed */
973 Index
*pOnlyIdx
, /* If not NULL, only analyze this one index */
974 int iStatCur
, /* Index of VdbeCursor that writes the sqlite_stat1 table */
975 int iMem
, /* Available memory locations begin here */
976 int iTab
/* Next available cursor */
978 sqlite3
*db
= pParse
->db
; /* Database handle */
979 Index
*pIdx
; /* An index to being analyzed */
980 int iIdxCur
; /* Cursor open on index being analyzed */
981 int iTabCur
; /* Table cursor */
982 Vdbe
*v
; /* The virtual machine being built up */
983 int i
; /* Loop counter */
984 int jZeroRows
= -1; /* Jump from here if number of rows is zero */
985 int iDb
; /* Index of database containing pTab */
986 u8 needTableCnt
= 1; /* True to count the table */
987 int regNewRowid
= iMem
++; /* Rowid for the inserted record */
988 int regStat
= iMem
++; /* Register to hold StatAccum object */
989 int regChng
= iMem
++; /* Index of changed index field */
990 int regRowid
= iMem
++; /* Rowid argument passed to stat_push() */
991 int regTemp
= iMem
++; /* Temporary use register */
992 int regTemp2
= iMem
++; /* Second temporary use register */
993 int regTabname
= iMem
++; /* Register containing table name */
994 int regIdxname
= iMem
++; /* Register containing index name */
995 int regStat1
= iMem
++; /* Value for the stat column of sqlite_stat1 */
996 int regPrev
= iMem
; /* MUST BE LAST (see below) */
997 #ifdef SQLITE_ENABLE_STAT4
998 int doOnce
= 1; /* Flag for a one-time computation */
1000 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1004 sqlite3TouchRegister(pParse
, iMem
);
1005 assert( sqlite3NoTempsInRange(pParse
, regNewRowid
, iMem
) );
1006 v
= sqlite3GetVdbe(pParse
);
1007 if( v
==0 || NEVER(pTab
==0) ){
1010 if( !IsOrdinaryTable(pTab
) ){
1011 /* Do not gather statistics on views or virtual tables */
1014 if( sqlite3_strlike("sqlite\\_%", pTab
->zName
, '\\')==0 ){
1015 /* Do not gather statistics on system tables */
1018 assert( sqlite3BtreeHoldsAllMutexes(db
) );
1019 iDb
= sqlite3SchemaToIndex(db
, pTab
->pSchema
);
1021 assert( sqlite3SchemaMutexHeld(db
, iDb
, 0) );
1022 #ifndef SQLITE_OMIT_AUTHORIZATION
1023 if( sqlite3AuthCheck(pParse
, SQLITE_ANALYZE
, pTab
->zName
, 0,
1024 db
->aDb
[iDb
].zDbSName
) ){
1029 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1030 if( db
->xPreUpdateCallback
){
1031 pStat1
= (Table
*)sqlite3DbMallocZero(db
, sizeof(Table
) + 13);
1032 if( pStat1
==0 ) return;
1033 pStat1
->zName
= (char*)&pStat1
[1];
1034 memcpy(pStat1
->zName
, "sqlite_stat1", 13);
1037 sqlite3VdbeAddOp4(pParse
->pVdbe
, OP_Noop
, 0, 0, 0,(char*)pStat1
,P4_DYNAMIC
);
1041 /* Establish a read-lock on the table at the shared-cache level.
1042 ** Open a read-only cursor on the table. Also allocate a cursor number
1043 ** to use for scanning indexes (iIdxCur). No index cursor is opened at
1044 ** this time though. */
1045 sqlite3TableLock(pParse
, iDb
, pTab
->tnum
, 0, pTab
->zName
);
1048 pParse
->nTab
= MAX(pParse
->nTab
, iTab
);
1049 sqlite3OpenTable(pParse
, iTabCur
, iDb
, pTab
, OP_OpenRead
);
1050 sqlite3VdbeLoadString(v
, regTabname
, pTab
->zName
);
1052 for(pIdx
=pTab
->pIndex
; pIdx
; pIdx
=pIdx
->pNext
){
1053 int nCol
; /* Number of columns in pIdx. "N" */
1054 int addrRewind
; /* Address of "OP_Rewind iIdxCur" */
1055 int addrNextRow
; /* Address of "next_row:" */
1056 const char *zIdxName
; /* Name of the index */
1057 int nColTest
; /* Number of columns to test for changes */
1059 if( pOnlyIdx
&& pOnlyIdx
!=pIdx
) continue;
1060 if( pIdx
->pPartIdxWhere
==0 ) needTableCnt
= 0;
1061 if( !HasRowid(pTab
) && IsPrimaryKeyIndex(pIdx
) ){
1062 nCol
= pIdx
->nKeyCol
;
1063 zIdxName
= pTab
->zName
;
1064 nColTest
= nCol
- 1;
1066 nCol
= pIdx
->nColumn
;
1067 zIdxName
= pIdx
->zName
;
1068 nColTest
= pIdx
->uniqNotNull
? pIdx
->nKeyCol
-1 : nCol
-1;
1071 /* Populate the register containing the index name. */
1072 sqlite3VdbeLoadString(v
, regIdxname
, zIdxName
);
1073 VdbeComment((v
, "Analysis for %s.%s", pTab
->zName
, zIdxName
));
1076 ** Pseudo-code for loop that calls stat_push():
1079 ** if eof(csr) goto end_of_scan;
1081 ** goto chng_addr_0;
1085 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1087 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1093 ** regPrev(0) = idx(0)
1095 ** regPrev(1) = idx(1)
1099 ** regRowid = idx(rowid)
1100 ** stat_push(P, regChng, regRowid)
1102 ** if !eof(csr) goto next_row;
1107 /* Make sure there are enough memory cells allocated to accommodate
1108 ** the regPrev array and a trailing rowid (the rowid slot is required
1109 ** when building a record to insert into the sample column of
1110 ** the sqlite_stat4 table. */
1111 sqlite3TouchRegister(pParse
, regPrev
+nColTest
);
1113 /* Open a read-only cursor on the index being analyzed. */
1114 assert( iDb
==sqlite3SchemaToIndex(db
, pIdx
->pSchema
) );
1115 sqlite3VdbeAddOp3(v
, OP_OpenRead
, iIdxCur
, pIdx
->tnum
, iDb
);
1116 sqlite3VdbeSetP4KeyInfo(pParse
, pIdx
);
1117 VdbeComment((v
, "%s", pIdx
->zName
));
1119 /* Invoke the stat_init() function. The arguments are:
1121 ** (1) the number of columns in the index including the rowid
1122 ** (or for a WITHOUT ROWID table, the number of PK columns),
1123 ** (2) the number of columns in the key without the rowid/pk
1124 ** (3) estimated number of rows in the index,
1126 sqlite3VdbeAddOp2(v
, OP_Integer
, nCol
, regStat
+1);
1127 assert( regRowid
==regStat
+2 );
1128 sqlite3VdbeAddOp2(v
, OP_Integer
, pIdx
->nKeyCol
, regRowid
);
1129 #ifdef SQLITE_ENABLE_STAT4
1130 if( OptimizationEnabled(db
, SQLITE_Stat4
) ){
1131 sqlite3VdbeAddOp2(v
, OP_Count
, iIdxCur
, regTemp
);
1132 addrRewind
= sqlite3VdbeAddOp1(v
, OP_Rewind
, iIdxCur
);
1137 addrRewind
= sqlite3VdbeAddOp1(v
, OP_Rewind
, iIdxCur
);
1139 sqlite3VdbeAddOp3(v
, OP_Count
, iIdxCur
, regTemp
, 1);
1141 assert( regTemp2
==regStat
+4 );
1142 sqlite3VdbeAddOp2(v
, OP_Integer
, db
->nAnalysisLimit
, regTemp2
);
1143 sqlite3VdbeAddFunctionCall(pParse
, 0, regStat
+1, regStat
, 4,
1144 &statInitFuncdef
, 0);
1146 /* Implementation of the following:
1149 ** if eof(csr) goto end_of_scan;
1151 ** goto next_push_0;
1154 sqlite3VdbeAddOp2(v
, OP_Integer
, 0, regChng
);
1155 addrNextRow
= sqlite3VdbeCurrentAddr(v
);
1158 int endDistinctTest
= sqlite3VdbeMakeLabel(pParse
);
1159 int *aGotoChng
; /* Array of jump instruction addresses */
1160 aGotoChng
= sqlite3DbMallocRawNN(db
, sizeof(int)*nColTest
);
1161 if( aGotoChng
==0 ) continue;
1166 ** if( idx(0) != regPrev(0) ) goto chng_addr_0
1168 ** if( idx(1) != regPrev(1) ) goto chng_addr_1
1171 ** goto endDistinctTest
1173 sqlite3VdbeAddOp0(v
, OP_Goto
);
1174 addrNextRow
= sqlite3VdbeCurrentAddr(v
);
1175 if( nColTest
==1 && pIdx
->nKeyCol
==1 && IsUniqueIndex(pIdx
) ){
1176 /* For a single-column UNIQUE index, once we have found a non-NULL
1177 ** row, we know that all the rest will be distinct, so skip
1178 ** subsequent distinctness tests. */
1179 sqlite3VdbeAddOp2(v
, OP_NotNull
, regPrev
, endDistinctTest
);
1182 for(i
=0; i
<nColTest
; i
++){
1183 char *pColl
= (char*)sqlite3LocateCollSeq(pParse
, pIdx
->azColl
[i
]);
1184 sqlite3VdbeAddOp2(v
, OP_Integer
, i
, regChng
);
1185 sqlite3VdbeAddOp3(v
, OP_Column
, iIdxCur
, i
, regTemp
);
1186 analyzeVdbeCommentIndexWithColumnName(v
,pIdx
,i
);
1188 sqlite3VdbeAddOp4(v
, OP_Ne
, regTemp
, 0, regPrev
+i
, pColl
, P4_COLLSEQ
);
1189 sqlite3VdbeChangeP5(v
, SQLITE_NULLEQ
);
1192 sqlite3VdbeAddOp2(v
, OP_Integer
, nColTest
, regChng
);
1193 sqlite3VdbeGoto(v
, endDistinctTest
);
1198 ** regPrev(0) = idx(0)
1200 ** regPrev(1) = idx(1)
1203 sqlite3VdbeJumpHere(v
, addrNextRow
-1);
1204 for(i
=0; i
<nColTest
; i
++){
1205 sqlite3VdbeJumpHere(v
, aGotoChng
[i
]);
1206 sqlite3VdbeAddOp3(v
, OP_Column
, iIdxCur
, i
, regPrev
+i
);
1207 analyzeVdbeCommentIndexWithColumnName(v
,pIdx
,i
);
1209 sqlite3VdbeResolveLabel(v
, endDistinctTest
);
1210 sqlite3DbFree(db
, aGotoChng
);
1215 ** regRowid = idx(rowid) // STAT4 only
1216 ** stat_push(P, regChng, regRowid) // 3rd parameter STAT4 only
1218 ** if !eof(csr) goto next_row;
1220 #ifdef SQLITE_ENABLE_STAT4
1221 if( OptimizationEnabled(db
, SQLITE_Stat4
) ){
1222 assert( regRowid
==(regStat
+2) );
1223 if( HasRowid(pTab
) ){
1224 sqlite3VdbeAddOp2(v
, OP_IdxRowid
, iIdxCur
, regRowid
);
1226 Index
*pPk
= sqlite3PrimaryKeyIndex(pIdx
->pTable
);
1228 regKey
= sqlite3GetTempRange(pParse
, pPk
->nKeyCol
);
1229 for(j
=0; j
<pPk
->nKeyCol
; j
++){
1230 k
= sqlite3TableColumnToIndex(pIdx
, pPk
->aiColumn
[j
]);
1231 assert( k
>=0 && k
<pIdx
->nColumn
);
1232 sqlite3VdbeAddOp3(v
, OP_Column
, iIdxCur
, k
, regKey
+j
);
1233 analyzeVdbeCommentIndexWithColumnName(v
,pIdx
,k
);
1235 sqlite3VdbeAddOp3(v
, OP_MakeRecord
, regKey
, pPk
->nKeyCol
, regRowid
);
1236 sqlite3ReleaseTempRange(pParse
, regKey
, pPk
->nKeyCol
);
1240 assert( regChng
==(regStat
+1) );
1242 sqlite3VdbeAddFunctionCall(pParse
, 1, regStat
, regTemp
, 2+IsStat4
,
1243 &statPushFuncdef
, 0);
1244 if( db
->nAnalysisLimit
){
1246 j1
= sqlite3VdbeAddOp1(v
, OP_IsNull
, regTemp
); VdbeCoverage(v
);
1247 j2
= sqlite3VdbeAddOp1(v
, OP_If
, regTemp
); VdbeCoverage(v
);
1248 j3
= sqlite3VdbeAddOp4Int(v
, OP_SeekGT
, iIdxCur
, 0, regPrev
, 1);
1250 sqlite3VdbeJumpHere(v
, j1
);
1251 sqlite3VdbeAddOp2(v
, OP_Next
, iIdxCur
, addrNextRow
); VdbeCoverage(v
);
1252 sqlite3VdbeJumpHere(v
, j2
);
1253 sqlite3VdbeJumpHere(v
, j3
);
1255 sqlite3VdbeAddOp2(v
, OP_Next
, iIdxCur
, addrNextRow
); VdbeCoverage(v
);
1259 /* Add the entry to the stat1 table. */
1260 callStatGet(pParse
, regStat
, STAT_GET_STAT1
, regStat1
);
1261 assert( "BBB"[0]==SQLITE_AFF_TEXT
);
1262 sqlite3VdbeAddOp4(v
, OP_MakeRecord
, regTabname
, 3, regTemp
, "BBB", 0);
1263 sqlite3VdbeAddOp2(v
, OP_NewRowid
, iStatCur
, regNewRowid
);
1264 sqlite3VdbeAddOp3(v
, OP_Insert
, iStatCur
, regTemp
, regNewRowid
);
1265 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1266 sqlite3VdbeChangeP4(v
, -1, (char*)pStat1
, P4_TABLE
);
1268 sqlite3VdbeChangeP5(v
, OPFLAG_APPEND
);
1270 /* Add the entries to the stat4 table. */
1271 #ifdef SQLITE_ENABLE_STAT4
1272 if( OptimizationEnabled(db
, SQLITE_Stat4
) && db
->nAnalysisLimit
==0 ){
1273 int regEq
= regStat1
;
1274 int regLt
= regStat1
+1;
1275 int regDLt
= regStat1
+2;
1276 int regSample
= regStat1
+3;
1277 int regCol
= regStat1
+4;
1278 int regSampleRowid
= regCol
+ nCol
;
1281 u8 seekOp
= HasRowid(pTab
) ? OP_NotExists
: OP_NotFound
;
1287 /* Compute the maximum number of columns in any index */
1288 for(pX
=pTab
->pIndex
; pX
; pX
=pX
->pNext
){
1289 int nColX
; /* Number of columns in pX */
1290 if( !HasRowid(pTab
) && IsPrimaryKeyIndex(pX
) ){
1291 nColX
= pX
->nKeyCol
;
1293 nColX
= pX
->nColumn
;
1295 if( nColX
>mxCol
) mxCol
= nColX
;
1298 /* Allocate space to compute results for the largest index */
1299 sqlite3TouchRegister(pParse
, regCol
+mxCol
);
1302 /* Verify that the call to sqlite3ClearTempRegCache() below
1303 ** really is needed.
1304 ** https://sqlite.org/forum/forumpost/83cb4a95a0 (2023-03-25)
1306 testcase( !sqlite3NoTempsInRange(pParse
, regEq
, regCol
+mxCol
) );
1308 sqlite3ClearTempRegCache(pParse
); /* tag-20230325-1 */
1309 assert( sqlite3NoTempsInRange(pParse
, regEq
, regCol
+mxCol
) );
1311 assert( sqlite3NoTempsInRange(pParse
, regEq
, regCol
+nCol
) );
1313 addrNext
= sqlite3VdbeCurrentAddr(v
);
1314 callStatGet(pParse
, regStat
, STAT_GET_ROWID
, regSampleRowid
);
1315 addrIsNull
= sqlite3VdbeAddOp1(v
, OP_IsNull
, regSampleRowid
);
1317 callStatGet(pParse
, regStat
, STAT_GET_NEQ
, regEq
);
1318 callStatGet(pParse
, regStat
, STAT_GET_NLT
, regLt
);
1319 callStatGet(pParse
, regStat
, STAT_GET_NDLT
, regDLt
);
1320 sqlite3VdbeAddOp4Int(v
, seekOp
, iTabCur
, addrNext
, regSampleRowid
, 0);
1322 for(i
=0; i
<nCol
; i
++){
1323 sqlite3ExprCodeLoadIndexColumn(pParse
, pIdx
, iTabCur
, i
, regCol
+i
);
1325 sqlite3VdbeAddOp3(v
, OP_MakeRecord
, regCol
, nCol
, regSample
);
1326 sqlite3VdbeAddOp3(v
, OP_MakeRecord
, regTabname
, 6, regTemp
);
1327 sqlite3VdbeAddOp2(v
, OP_NewRowid
, iStatCur
+1, regNewRowid
);
1328 sqlite3VdbeAddOp3(v
, OP_Insert
, iStatCur
+1, regTemp
, regNewRowid
);
1329 sqlite3VdbeAddOp2(v
, OP_Goto
, 1, addrNext
); /* P1==1 for end-of-loop */
1330 sqlite3VdbeJumpHere(v
, addrIsNull
);
1332 #endif /* SQLITE_ENABLE_STAT4 */
1334 /* End of analysis */
1335 sqlite3VdbeJumpHere(v
, addrRewind
);
1339 /* Create a single sqlite_stat1 entry containing NULL as the index
1340 ** name and the row count as the content.
1342 if( pOnlyIdx
==0 && needTableCnt
){
1343 VdbeComment((v
, "%s", pTab
->zName
));
1344 sqlite3VdbeAddOp2(v
, OP_Count
, iTabCur
, regStat1
);
1345 jZeroRows
= sqlite3VdbeAddOp1(v
, OP_IfNot
, regStat1
); VdbeCoverage(v
);
1346 sqlite3VdbeAddOp2(v
, OP_Null
, 0, regIdxname
);
1347 assert( "BBB"[0]==SQLITE_AFF_TEXT
);
1348 sqlite3VdbeAddOp4(v
, OP_MakeRecord
, regTabname
, 3, regTemp
, "BBB", 0);
1349 sqlite3VdbeAddOp2(v
, OP_NewRowid
, iStatCur
, regNewRowid
);
1350 sqlite3VdbeAddOp3(v
, OP_Insert
, iStatCur
, regTemp
, regNewRowid
);
1351 sqlite3VdbeChangeP5(v
, OPFLAG_APPEND
);
1352 #ifdef SQLITE_ENABLE_PREUPDATE_HOOK
1353 sqlite3VdbeChangeP4(v
, -1, (char*)pStat1
, P4_TABLE
);
1355 sqlite3VdbeJumpHere(v
, jZeroRows
);
1361 ** Generate code that will cause the most recent index analysis to
1362 ** be loaded into internal hash tables where is can be used.
1364 static void loadAnalysis(Parse
*pParse
, int iDb
){
1365 Vdbe
*v
= sqlite3GetVdbe(pParse
);
1367 sqlite3VdbeAddOp1(v
, OP_LoadAnalysis
, iDb
);
1372 ** Generate code that will do an analysis of an entire database
1374 static void analyzeDatabase(Parse
*pParse
, int iDb
){
1375 sqlite3
*db
= pParse
->db
;
1376 Schema
*pSchema
= db
->aDb
[iDb
].pSchema
; /* Schema of database iDb */
1382 sqlite3BeginWriteOperation(pParse
, 0, iDb
);
1383 iStatCur
= pParse
->nTab
;
1385 openStatTable(pParse
, iDb
, iStatCur
, 0, 0);
1386 iMem
= pParse
->nMem
+1;
1387 iTab
= pParse
->nTab
;
1388 assert( sqlite3SchemaMutexHeld(db
, iDb
, 0) );
1389 for(k
=sqliteHashFirst(&pSchema
->tblHash
); k
; k
=sqliteHashNext(k
)){
1390 Table
*pTab
= (Table
*)sqliteHashData(k
);
1391 analyzeOneTable(pParse
, pTab
, 0, iStatCur
, iMem
, iTab
);
1392 #ifdef SQLITE_ENABLE_STAT4
1393 iMem
= sqlite3FirstAvailableRegister(pParse
, iMem
);
1395 assert( iMem
==sqlite3FirstAvailableRegister(pParse
,iMem
) );
1398 loadAnalysis(pParse
, iDb
);
1402 ** Generate code that will do an analysis of a single table in
1403 ** a database. If pOnlyIdx is not NULL then it is a single index
1404 ** in pTab that should be analyzed.
1406 static void analyzeTable(Parse
*pParse
, Table
*pTab
, Index
*pOnlyIdx
){
1411 assert( sqlite3BtreeHoldsAllMutexes(pParse
->db
) );
1412 iDb
= sqlite3SchemaToIndex(pParse
->db
, pTab
->pSchema
);
1413 sqlite3BeginWriteOperation(pParse
, 0, iDb
);
1414 iStatCur
= pParse
->nTab
;
1417 openStatTable(pParse
, iDb
, iStatCur
, pOnlyIdx
->zName
, "idx");
1419 openStatTable(pParse
, iDb
, iStatCur
, pTab
->zName
, "tbl");
1421 analyzeOneTable(pParse
, pTab
, pOnlyIdx
, iStatCur
,pParse
->nMem
+1,pParse
->nTab
);
1422 loadAnalysis(pParse
, iDb
);
1426 ** Generate code for the ANALYZE command. The parser calls this routine
1427 ** when it recognizes an ANALYZE command.
1430 ** ANALYZE <database> -- 2
1431 ** ANALYZE ?<database>.?<tablename> -- 3
1433 ** Form 1 causes all indices in all attached databases to be analyzed.
1434 ** Form 2 analyzes all indices the single database named.
1435 ** Form 3 analyzes all indices associated with the named table.
1437 void sqlite3Analyze(Parse
*pParse
, Token
*pName1
, Token
*pName2
){
1438 sqlite3
*db
= pParse
->db
;
1447 /* Read the database schema. If an error occurs, leave an error message
1448 ** and code in pParse and return NULL. */
1449 assert( sqlite3BtreeHoldsAllMutexes(pParse
->db
) );
1450 if( SQLITE_OK
!=sqlite3ReadSchema(pParse
) ){
1454 assert( pName2
!=0 || pName1
==0 );
1456 /* Form 1: Analyze everything */
1457 for(i
=0; i
<db
->nDb
; i
++){
1458 if( i
==1 ) continue; /* Do not analyze the TEMP database */
1459 analyzeDatabase(pParse
, i
);
1461 }else if( pName2
->n
==0 && (iDb
= sqlite3FindDb(db
, pName1
))>=0 ){
1462 /* Analyze the schema named as the argument */
1463 analyzeDatabase(pParse
, iDb
);
1465 /* Form 3: Analyze the table or index named as an argument */
1466 iDb
= sqlite3TwoPartName(pParse
, pName1
, pName2
, &pTableName
);
1468 zDb
= pName2
->n
? db
->aDb
[iDb
].zDbSName
: 0;
1469 z
= sqlite3NameFromToken(db
, pTableName
);
1471 if( (pIdx
= sqlite3FindIndex(db
, z
, zDb
))!=0 ){
1472 analyzeTable(pParse
, pIdx
->pTable
, pIdx
);
1473 }else if( (pTab
= sqlite3LocateTable(pParse
, 0, z
, zDb
))!=0 ){
1474 analyzeTable(pParse
, pTab
, 0);
1476 sqlite3DbFree(db
, z
);
1480 if( db
->nSqlExec
==0 && (v
= sqlite3GetVdbe(pParse
))!=0 ){
1481 sqlite3VdbeAddOp0(v
, OP_Expire
);
1486 ** Used to pass information from the analyzer reader through to the
1487 ** callback routine.
1489 typedef struct analysisInfo analysisInfo
;
1490 struct analysisInfo
{
1492 const char *zDatabase
;
1496 ** The first argument points to a nul-terminated string containing a
1497 ** list of space separated integers. Read the first nOut of these into
1498 ** the array aOut[].
1500 static void decodeIntArray(
1501 char *zIntArray
, /* String containing int array to decode */
1502 int nOut
, /* Number of slots in aOut[] */
1503 tRowcnt
*aOut
, /* Store integers here */
1504 LogEst
*aLog
, /* Or, if aOut==0, here */
1505 Index
*pIndex
/* Handle extra flags for this index, if not NULL */
1507 char *z
= zIntArray
;
1512 #ifdef SQLITE_ENABLE_STAT4
1517 for(i
=0; *z
&& i
<nOut
; i
++){
1519 while( (c
=z
[0])>='0' && c
<='9' ){
1523 #ifdef SQLITE_ENABLE_STAT4
1524 if( aOut
) aOut
[i
] = v
;
1525 if( aLog
) aLog
[i
] = sqlite3LogEst(v
);
1528 UNUSED_PARAMETER(aOut
);
1530 aLog
[i
] = sqlite3LogEst(v
);
1534 #ifndef SQLITE_ENABLE_STAT4
1535 assert( pIndex
!=0 ); {
1539 pIndex
->bUnordered
= 0;
1540 pIndex
->noSkipScan
= 0;
1542 if( sqlite3_strglob("unordered*", z
)==0 ){
1543 pIndex
->bUnordered
= 1;
1544 }else if( sqlite3_strglob("sz=[0-9]*", z
)==0 ){
1545 int sz
= sqlite3Atoi(z
+3);
1547 pIndex
->szIdxRow
= sqlite3LogEst(sz
);
1548 }else if( sqlite3_strglob("noskipscan*", z
)==0 ){
1549 pIndex
->noSkipScan
= 1;
1551 #ifdef SQLITE_ENABLE_COSTMULT
1552 else if( sqlite3_strglob("costmult=[0-9]*",z
)==0 ){
1553 pIndex
->pTable
->costMult
= sqlite3LogEst(sqlite3Atoi(z
+9));
1556 while( z
[0]!=0 && z
[0]!=' ' ) z
++;
1557 while( z
[0]==' ' ) z
++;
1563 ** This callback is invoked once for each index when reading the
1564 ** sqlite_stat1 table.
1566 ** argv[0] = name of the table
1567 ** argv[1] = name of the index (might be NULL)
1568 ** argv[2] = results of analysis - on integer for each column
1570 ** Entries for which argv[1]==NULL simply record the number of rows in
1573 static int analysisLoader(void *pData
, int argc
, char **argv
, char **NotUsed
){
1574 analysisInfo
*pInfo
= (analysisInfo
*)pData
;
1580 UNUSED_PARAMETER2(NotUsed
, argc
);
1582 if( argv
==0 || argv
[0]==0 || argv
[2]==0 ){
1585 pTable
= sqlite3FindTable(pInfo
->db
, argv
[0], pInfo
->zDatabase
);
1591 }else if( sqlite3_stricmp(argv
[0],argv
[1])==0 ){
1592 pIndex
= sqlite3PrimaryKeyIndex(pTable
);
1594 pIndex
= sqlite3FindIndex(pInfo
->db
, argv
[1], pInfo
->zDatabase
);
1599 tRowcnt
*aiRowEst
= 0;
1600 int nCol
= pIndex
->nKeyCol
+1;
1601 #ifdef SQLITE_ENABLE_STAT4
1602 /* Index.aiRowEst may already be set here if there are duplicate
1603 ** sqlite_stat1 entries for this index. In that case just clobber
1604 ** the old data with the new instead of allocating a new array. */
1605 if( pIndex
->aiRowEst
==0 ){
1606 pIndex
->aiRowEst
= (tRowcnt
*)sqlite3MallocZero(sizeof(tRowcnt
) * nCol
);
1607 if( pIndex
->aiRowEst
==0 ) sqlite3OomFault(pInfo
->db
);
1609 aiRowEst
= pIndex
->aiRowEst
;
1611 pIndex
->bUnordered
= 0;
1612 decodeIntArray((char*)z
, nCol
, aiRowEst
, pIndex
->aiRowLogEst
, pIndex
);
1613 pIndex
->hasStat1
= 1;
1614 if( pIndex
->pPartIdxWhere
==0 ){
1615 pTable
->nRowLogEst
= pIndex
->aiRowLogEst
[0];
1616 pTable
->tabFlags
|= TF_HasStat1
;
1620 fakeIdx
.szIdxRow
= pTable
->szTabRow
;
1621 #ifdef SQLITE_ENABLE_COSTMULT
1622 fakeIdx
.pTable
= pTable
;
1624 decodeIntArray((char*)z
, 1, 0, &pTable
->nRowLogEst
, &fakeIdx
);
1625 pTable
->szTabRow
= fakeIdx
.szIdxRow
;
1626 pTable
->tabFlags
|= TF_HasStat1
;
1633 ** If the Index.aSample variable is not NULL, delete the aSample[] array
1634 ** and its contents.
1636 void sqlite3DeleteIndexSamples(sqlite3
*db
, Index
*pIdx
){
1639 #ifdef SQLITE_ENABLE_STAT4
1640 if( pIdx
->aSample
){
1642 for(j
=0; j
<pIdx
->nSample
; j
++){
1643 IndexSample
*p
= &pIdx
->aSample
[j
];
1644 sqlite3DbFree(db
, p
->p
);
1646 sqlite3DbFree(db
, pIdx
->aSample
);
1648 if( db
->pnBytesFreed
==0 ){
1653 UNUSED_PARAMETER(db
);
1654 UNUSED_PARAMETER(pIdx
);
1655 #endif /* SQLITE_ENABLE_STAT4 */
1658 #ifdef SQLITE_ENABLE_STAT4
1660 ** Populate the pIdx->aAvgEq[] array based on the samples currently
1661 ** stored in pIdx->aSample[].
1663 static void initAvgEq(Index
*pIdx
){
1665 IndexSample
*aSample
= pIdx
->aSample
;
1666 IndexSample
*pFinal
= &aSample
[pIdx
->nSample
-1];
1669 if( pIdx
->nSampleCol
>1 ){
1670 /* If this is stat4 data, then calculate aAvgEq[] values for all
1671 ** sample columns except the last. The last is always set to 1, as
1672 ** once the trailing PK fields are considered all index keys are
1674 nCol
= pIdx
->nSampleCol
-1;
1675 pIdx
->aAvgEq
[nCol
] = 1;
1677 for(iCol
=0; iCol
<nCol
; iCol
++){
1678 int nSample
= pIdx
->nSample
;
1679 int i
; /* Used to iterate through samples */
1680 tRowcnt sumEq
= 0; /* Sum of the nEq values */
1682 tRowcnt nRow
; /* Number of rows in index */
1683 i64 nSum100
= 0; /* Number of terms contributing to sumEq */
1684 i64 nDist100
; /* Number of distinct values in index */
1686 if( !pIdx
->aiRowEst
|| iCol
>=pIdx
->nKeyCol
|| pIdx
->aiRowEst
[iCol
+1]==0 ){
1687 nRow
= pFinal
->anLt
[iCol
];
1688 nDist100
= (i64
)100 * pFinal
->anDLt
[iCol
];
1691 nRow
= pIdx
->aiRowEst
[0];
1692 nDist100
= ((i64
)100 * pIdx
->aiRowEst
[0]) / pIdx
->aiRowEst
[iCol
+1];
1694 pIdx
->nRowEst0
= nRow
;
1696 /* Set nSum to the number of distinct (iCol+1) field prefixes that
1697 ** occur in the stat4 table for this index. Set sumEq to the sum of
1698 ** the nEq values for column iCol for the same set (adding the value
1699 ** only once where there exist duplicate prefixes). */
1700 for(i
=0; i
<nSample
; i
++){
1701 if( i
==(pIdx
->nSample
-1)
1702 || aSample
[i
].anDLt
[iCol
]!=aSample
[i
+1].anDLt
[iCol
]
1704 sumEq
+= aSample
[i
].anEq
[iCol
];
1709 if( nDist100
>nSum100
&& sumEq
<nRow
){
1710 avgEq
= ((i64
)100 * (nRow
- sumEq
))/(nDist100
- nSum100
);
1712 if( avgEq
==0 ) avgEq
= 1;
1713 pIdx
->aAvgEq
[iCol
] = avgEq
;
1719 ** Look up an index by name. Or, if the name of a WITHOUT ROWID table
1720 ** is supplied instead, find the PRIMARY KEY index for that table.
1722 static Index
*findIndexOrPrimaryKey(
1727 Index
*pIdx
= sqlite3FindIndex(db
, zName
, zDb
);
1729 Table
*pTab
= sqlite3FindTable(db
, zName
, zDb
);
1730 if( pTab
&& !HasRowid(pTab
) ) pIdx
= sqlite3PrimaryKeyIndex(pTab
);
1736 ** Load the content from either the sqlite_stat4
1737 ** into the relevant Index.aSample[] arrays.
1739 ** Arguments zSql1 and zSql2 must point to SQL statements that return
1740 ** data equivalent to the following:
1742 ** zSql1: SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx
1743 ** zSql2: SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4
1745 ** where %Q is replaced with the database name before the SQL is executed.
1747 static int loadStatTbl(
1748 sqlite3
*db
, /* Database handle */
1749 const char *zSql1
, /* SQL statement 1 (see above) */
1750 const char *zSql2
, /* SQL statement 2 (see above) */
1751 const char *zDb
/* Database name (e.g. "main") */
1753 int rc
; /* Result codes from subroutines */
1754 sqlite3_stmt
*pStmt
= 0; /* An SQL statement being run */
1755 char *zSql
; /* Text of the SQL statement */
1756 Index
*pPrevIdx
= 0; /* Previous index in the loop */
1757 IndexSample
*pSample
; /* A slot in pIdx->aSample[] */
1759 assert( db
->lookaside
.bDisable
);
1760 zSql
= sqlite3MPrintf(db
, zSql1
, zDb
);
1762 return SQLITE_NOMEM_BKPT
;
1764 rc
= sqlite3_prepare(db
, zSql
, -1, &pStmt
, 0);
1765 sqlite3DbFree(db
, zSql
);
1768 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
1769 int nIdxCol
= 1; /* Number of columns in stat4 records */
1771 char *zIndex
; /* Index name */
1772 Index
*pIdx
; /* Pointer to the index object */
1773 int nSample
; /* Number of samples */
1774 int nByte
; /* Bytes of space required */
1775 int i
; /* Bytes of space required */
1778 zIndex
= (char *)sqlite3_column_text(pStmt
, 0);
1779 if( zIndex
==0 ) continue;
1780 nSample
= sqlite3_column_int(pStmt
, 1);
1781 pIdx
= findIndexOrPrimaryKey(db
, zIndex
, zDb
);
1782 assert( pIdx
==0 || pIdx
->nSample
==0 );
1783 if( pIdx
==0 ) continue;
1784 if( pIdx
->aSample
!=0 ){
1785 /* The same index appears in sqlite_stat4 under multiple names */
1788 assert( !HasRowid(pIdx
->pTable
) || pIdx
->nColumn
==pIdx
->nKeyCol
+1 );
1789 if( !HasRowid(pIdx
->pTable
) && IsPrimaryKeyIndex(pIdx
) ){
1790 nIdxCol
= pIdx
->nKeyCol
;
1792 nIdxCol
= pIdx
->nColumn
;
1794 pIdx
->nSampleCol
= nIdxCol
;
1795 pIdx
->mxSample
= nSample
;
1796 nByte
= sizeof(IndexSample
) * nSample
;
1797 nByte
+= sizeof(tRowcnt
) * nIdxCol
* 3 * nSample
;
1798 nByte
+= nIdxCol
* sizeof(tRowcnt
); /* Space for Index.aAvgEq[] */
1800 pIdx
->aSample
= sqlite3DbMallocZero(db
, nByte
);
1801 if( pIdx
->aSample
==0 ){
1802 sqlite3_finalize(pStmt
);
1803 return SQLITE_NOMEM_BKPT
;
1805 pSpace
= (tRowcnt
*)&pIdx
->aSample
[nSample
];
1806 pIdx
->aAvgEq
= pSpace
; pSpace
+= nIdxCol
;
1807 pIdx
->pTable
->tabFlags
|= TF_HasStat4
;
1808 for(i
=0; i
<nSample
; i
++){
1809 pIdx
->aSample
[i
].anEq
= pSpace
; pSpace
+= nIdxCol
;
1810 pIdx
->aSample
[i
].anLt
= pSpace
; pSpace
+= nIdxCol
;
1811 pIdx
->aSample
[i
].anDLt
= pSpace
; pSpace
+= nIdxCol
;
1813 assert( ((u8
*)pSpace
)-nByte
==(u8
*)(pIdx
->aSample
) );
1815 rc
= sqlite3_finalize(pStmt
);
1818 zSql
= sqlite3MPrintf(db
, zSql2
, zDb
);
1820 return SQLITE_NOMEM_BKPT
;
1822 rc
= sqlite3_prepare(db
, zSql
, -1, &pStmt
, 0);
1823 sqlite3DbFree(db
, zSql
);
1826 while( sqlite3_step(pStmt
)==SQLITE_ROW
){
1827 char *zIndex
; /* Index name */
1828 Index
*pIdx
; /* Pointer to the index object */
1829 int nCol
= 1; /* Number of columns in index */
1831 zIndex
= (char *)sqlite3_column_text(pStmt
, 0);
1832 if( zIndex
==0 ) continue;
1833 pIdx
= findIndexOrPrimaryKey(db
, zIndex
, zDb
);
1834 if( pIdx
==0 ) continue;
1835 if( pIdx
->nSample
>=pIdx
->mxSample
){
1836 /* Too many slots used because the same index appears in
1837 ** sqlite_stat4 using multiple names */
1840 /* This next condition is true if data has already been loaded from
1841 ** the sqlite_stat4 table. */
1842 nCol
= pIdx
->nSampleCol
;
1843 if( pIdx
!=pPrevIdx
){
1844 initAvgEq(pPrevIdx
);
1847 pSample
= &pIdx
->aSample
[pIdx
->nSample
];
1848 decodeIntArray((char*)sqlite3_column_text(pStmt
,1),nCol
,pSample
->anEq
,0,0);
1849 decodeIntArray((char*)sqlite3_column_text(pStmt
,2),nCol
,pSample
->anLt
,0,0);
1850 decodeIntArray((char*)sqlite3_column_text(pStmt
,3),nCol
,pSample
->anDLt
,0,0);
1852 /* Take a copy of the sample. Add two 0x00 bytes the end of the buffer.
1853 ** This is in case the sample record is corrupted. In that case, the
1854 ** sqlite3VdbeRecordCompare() may read up to two varints past the
1855 ** end of the allocated buffer before it realizes it is dealing with
1856 ** a corrupt record. Adding the two 0x00 bytes prevents this from causing
1857 ** a buffer overread. */
1858 pSample
->n
= sqlite3_column_bytes(pStmt
, 4);
1859 pSample
->p
= sqlite3DbMallocZero(db
, pSample
->n
+ 2);
1860 if( pSample
->p
==0 ){
1861 sqlite3_finalize(pStmt
);
1862 return SQLITE_NOMEM_BKPT
;
1865 memcpy(pSample
->p
, sqlite3_column_blob(pStmt
, 4), pSample
->n
);
1869 rc
= sqlite3_finalize(pStmt
);
1870 if( rc
==SQLITE_OK
) initAvgEq(pPrevIdx
);
1875 ** Load content from the sqlite_stat4 table into
1876 ** the Index.aSample[] arrays of all indices.
1878 static int loadStat4(sqlite3
*db
, const char *zDb
){
1879 int rc
= SQLITE_OK
; /* Result codes from subroutines */
1880 const Table
*pStat4
;
1882 assert( db
->lookaside
.bDisable
);
1883 if( OptimizationEnabled(db
, SQLITE_Stat4
)
1884 && (pStat4
= sqlite3FindTable(db
, "sqlite_stat4", zDb
))!=0
1885 && IsOrdinaryTable(pStat4
)
1887 rc
= loadStatTbl(db
,
1888 "SELECT idx,count(*) FROM %Q.sqlite_stat4 GROUP BY idx COLLATE nocase",
1889 "SELECT idx,neq,nlt,ndlt,sample FROM %Q.sqlite_stat4",
1895 #endif /* SQLITE_ENABLE_STAT4 */
1898 ** Load the content of the sqlite_stat1 and sqlite_stat4 tables. The
1899 ** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
1900 ** arrays. The contents of sqlite_stat4 are used to populate the
1901 ** Index.aSample[] arrays.
1903 ** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
1904 ** is returned. In this case, even if SQLITE_ENABLE_STAT4 was defined
1905 ** during compilation and the sqlite_stat4 table is present, no data is
1908 ** If SQLITE_ENABLE_STAT4 was defined during compilation and the
1909 ** sqlite_stat4 table is not present in the database, SQLITE_ERROR is
1910 ** returned. However, in this case, data is read from the sqlite_stat1
1911 ** table (if it is present) before returning.
1913 ** If an OOM error occurs, this function always sets db->mallocFailed.
1914 ** This means if the caller does not care about other errors, the return
1915 ** code may be ignored.
1917 int sqlite3AnalysisLoad(sqlite3
*db
, int iDb
){
1922 Schema
*pSchema
= db
->aDb
[iDb
].pSchema
;
1923 const Table
*pStat1
;
1925 assert( iDb
>=0 && iDb
<db
->nDb
);
1926 assert( db
->aDb
[iDb
].pBt
!=0 );
1928 /* Clear any prior statistics */
1929 assert( sqlite3SchemaMutexHeld(db
, iDb
, 0) );
1930 for(i
=sqliteHashFirst(&pSchema
->tblHash
); i
; i
=sqliteHashNext(i
)){
1931 Table
*pTab
= sqliteHashData(i
);
1932 pTab
->tabFlags
&= ~TF_HasStat1
;
1934 for(i
=sqliteHashFirst(&pSchema
->idxHash
); i
; i
=sqliteHashNext(i
)){
1935 Index
*pIdx
= sqliteHashData(i
);
1937 #ifdef SQLITE_ENABLE_STAT4
1938 sqlite3DeleteIndexSamples(db
, pIdx
);
1943 /* Load new statistics out of the sqlite_stat1 table */
1945 sInfo
.zDatabase
= db
->aDb
[iDb
].zDbSName
;
1946 if( (pStat1
= sqlite3FindTable(db
, "sqlite_stat1", sInfo
.zDatabase
))
1947 && IsOrdinaryTable(pStat1
)
1949 zSql
= sqlite3MPrintf(db
,
1950 "SELECT tbl,idx,stat FROM %Q.sqlite_stat1", sInfo
.zDatabase
);
1952 rc
= SQLITE_NOMEM_BKPT
;
1954 rc
= sqlite3_exec(db
, zSql
, analysisLoader
, &sInfo
, 0);
1955 sqlite3DbFree(db
, zSql
);
1959 /* Set appropriate defaults on all indexes not in the sqlite_stat1 table */
1960 assert( sqlite3SchemaMutexHeld(db
, iDb
, 0) );
1961 for(i
=sqliteHashFirst(&pSchema
->idxHash
); i
; i
=sqliteHashNext(i
)){
1962 Index
*pIdx
= sqliteHashData(i
);
1963 if( !pIdx
->hasStat1
) sqlite3DefaultRowEst(pIdx
);
1966 /* Load the statistics from the sqlite_stat4 table. */
1967 #ifdef SQLITE_ENABLE_STAT4
1968 if( rc
==SQLITE_OK
){
1970 rc
= loadStat4(db
, sInfo
.zDatabase
);
1973 for(i
=sqliteHashFirst(&pSchema
->idxHash
); i
; i
=sqliteHashNext(i
)){
1974 Index
*pIdx
= sqliteHashData(i
);
1975 sqlite3_free(pIdx
->aiRowEst
);
1980 if( rc
==SQLITE_NOMEM
){
1981 sqlite3OomFault(db
);
1987 #endif /* SQLITE_OMIT_ANALYZE */