blob: d96deb3c2120a7c48ec4a099a67518c302a2d5aa [file] [log] [blame]
drh9f18e8a2005-07-08 12:13:04 +00001/*
2** 2005 July 8
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.
10**
11*************************************************************************
12** This file contains code associated with the ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +000013*/
14#ifndef SQLITE_OMIT_ANALYZE
15#include "sqliteInt.h"
16
17/*
dan02fa4692009-08-17 17:06:58 +000018** This routine generates code that opens the sqlite_stat1 table for
dan69188d92009-08-19 08:18:32 +000019** writing with cursor iStatCur. If the library was built with the
20** SQLITE_ENABLE_STAT2 macro defined, then the sqlite_stat2 table is
21** opened for writing using cursor (iStatCur+1)
drhff2d5ea2005-07-23 00:41:48 +000022**
23** If the sqlite_stat1 tables does not previously exist, it is created.
dan69188d92009-08-19 08:18:32 +000024** Similarly, if the sqlite_stat2 table does not exist and the library
25** is compiled with SQLITE_ENABLE_STAT2 defined, it is created.
26**
27** Argument zWhere may be a pointer to a buffer containing a table name,
28** or it may be a NULL pointer. If it is not NULL, then all entries in
29** the sqlite_stat1 and (if applicable) sqlite_stat2 tables associated
30** with the named table are deleted. If zWhere==0, then code is generated
31** to delete all stat table entries.
drhff2d5ea2005-07-23 00:41:48 +000032*/
33static void openStatTable(
34 Parse *pParse, /* Parsing context */
35 int iDb, /* The database we are looking in */
36 int iStatCur, /* Open the sqlite_stat1 table on this cursor */
37 const char *zWhere /* Delete entries associated with this table */
38){
dan558814f2010-06-02 05:53:53 +000039 static const struct {
dan69188d92009-08-19 08:18:32 +000040 const char *zName;
41 const char *zCols;
42 } aTable[] = {
43 { "sqlite_stat1", "tbl,idx,stat" },
44#ifdef SQLITE_ENABLE_STAT2
45 { "sqlite_stat2", "tbl,idx,sampleno,sample" },
46#endif
47 };
48
dan02fa4692009-08-17 17:06:58 +000049 int aRoot[] = {0, 0};
shanecea72b22009-09-07 04:38:36 +000050 u8 aCreateTbl[] = {0, 0};
dan02fa4692009-08-17 17:06:58 +000051
52 int i;
drhff2d5ea2005-07-23 00:41:48 +000053 sqlite3 *db = pParse->db;
54 Db *pDb;
drhff2d5ea2005-07-23 00:41:48 +000055 Vdbe *v = sqlite3GetVdbe(pParse);
drhcf1be452007-05-12 12:08:51 +000056 if( v==0 ) return;
drh1fee73e2007-08-29 04:00:57 +000057 assert( sqlite3BtreeHoldsAllMutexes(db) );
58 assert( sqlite3VdbeDb(v)==db );
drhff2d5ea2005-07-23 00:41:48 +000059 pDb = &db->aDb[iDb];
dan02fa4692009-08-17 17:06:58 +000060
dan69188d92009-08-19 08:18:32 +000061 for(i=0; i<ArraySize(aTable); i++){
62 const char *zTab = aTable[i].zName;
dan02fa4692009-08-17 17:06:58 +000063 Table *pStat;
dan69188d92009-08-19 08:18:32 +000064 if( (pStat = sqlite3FindTable(db, zTab, pDb->zName))==0 ){
dan02fa4692009-08-17 17:06:58 +000065 /* The sqlite_stat[12] table does not exist. Create it. Note that a
66 ** side-effect of the CREATE TABLE statement is to leave the rootpage
67 ** of the new table in register pParse->regRoot. This is important
68 ** because the OpenWrite opcode below will be needing it. */
69 sqlite3NestedParse(pParse,
dan69188d92009-08-19 08:18:32 +000070 "CREATE TABLE %Q.%s(%s)", pDb->zName, zTab, aTable[i].zCols
dan02fa4692009-08-17 17:06:58 +000071 );
72 aRoot[i] = pParse->regRoot;
73 aCreateTbl[i] = 1;
74 }else{
75 /* The table already exists. If zWhere is not NULL, delete all entries
76 ** associated with the table zWhere. If zWhere is NULL, delete the
77 ** entire contents of the table. */
78 aRoot[i] = pStat->tnum;
dan69188d92009-08-19 08:18:32 +000079 sqlite3TableLock(pParse, iDb, aRoot[i], 1, zTab);
dan02fa4692009-08-17 17:06:58 +000080 if( zWhere ){
81 sqlite3NestedParse(pParse,
dan69188d92009-08-19 08:18:32 +000082 "DELETE FROM %Q.%s WHERE tbl=%Q", pDb->zName, zTab, zWhere
dan02fa4692009-08-17 17:06:58 +000083 );
84 }else{
85 /* The sqlite_stat[12] table already exists. Delete all rows. */
86 sqlite3VdbeAddOp2(v, OP_Clear, aRoot[i], iDb);
87 }
88 }
drhff2d5ea2005-07-23 00:41:48 +000089 }
90
dan02fa4692009-08-17 17:06:58 +000091 /* Open the sqlite_stat[12] tables for writing. */
dan69188d92009-08-19 08:18:32 +000092 for(i=0; i<ArraySize(aTable); i++){
dan02fa4692009-08-17 17:06:58 +000093 sqlite3VdbeAddOp3(v, OP_OpenWrite, iStatCur+i, aRoot[i], iDb);
94 sqlite3VdbeChangeP4(v, -1, (char *)3, P4_INT32);
95 sqlite3VdbeChangeP5(v, aCreateTbl[i]);
danielk1977c00da102006-01-07 13:21:04 +000096 }
drhff2d5ea2005-07-23 00:41:48 +000097}
98
99/*
100** Generate code to do an analysis of all indices associated with
101** a single table.
102*/
103static void analyzeOneTable(
104 Parse *pParse, /* Parser context */
105 Table *pTab, /* Table whose indices are to be analyzed */
drhdfe88ec2008-11-03 20:55:06 +0000106 int iStatCur, /* Index of VdbeCursor that writes the sqlite_stat1 table */
drhff2d5ea2005-07-23 00:41:48 +0000107 int iMem /* Available memory locations begin here */
108){
dan0f9a34e2009-08-19 16:34:31 +0000109 sqlite3 *db = pParse->db; /* Database handle */
dan69188d92009-08-19 08:18:32 +0000110 Index *pIdx; /* An index to being analyzed */
111 int iIdxCur; /* Cursor open on index being analyzed */
112 Vdbe *v; /* The virtual machine being built up */
113 int i; /* Loop counter */
114 int topOfLoop; /* The top of the loop */
115 int endOfLoop; /* The end of the loop */
116 int addr; /* The address of an instruction */
117 int iDb; /* Index of database containing pTab */
dane275dc32009-08-18 16:24:58 +0000118 int regTabname = iMem++; /* Register containing table name */
119 int regIdxname = iMem++; /* Register containing index name */
120 int regSampleno = iMem++; /* Register containing next sample number */
121 int regCol = iMem++; /* Content of a column analyzed table */
dane275dc32009-08-18 16:24:58 +0000122 int regRec = iMem++; /* Register holding completed record */
123 int regTemp = iMem++; /* Temporary use register */
dane275dc32009-08-18 16:24:58 +0000124 int regRowid = iMem++; /* Rowid for the inserted record */
dan68c4dbb2009-08-20 09:11:06 +0000125
dan69188d92009-08-19 08:18:32 +0000126#ifdef SQLITE_ENABLE_STAT2
127 int regTemp2 = iMem++; /* Temporary use register */
dan68c4dbb2009-08-20 09:11:06 +0000128 int regSamplerecno = iMem++; /* Index of next sample to record */
129 int regRecno = iMem++; /* Current sample index */
130 int regLast = iMem++; /* Index of last sample to record */
131 int regFirst = iMem++; /* Index of first sample to record */
dan69188d92009-08-19 08:18:32 +0000132#endif
dane275dc32009-08-18 16:24:58 +0000133
drhff2d5ea2005-07-23 00:41:48 +0000134 v = sqlite3GetVdbe(pParse);
drh05800a12009-04-16 17:45:47 +0000135 if( v==0 || NEVER(pTab==0) || pTab->pIndex==0 ){
drh0c356672005-09-10 22:40:53 +0000136 /* Do no analysis for tables that have no indices */
drhff2d5ea2005-07-23 00:41:48 +0000137 return;
138 }
dan0f9a34e2009-08-19 16:34:31 +0000139 assert( sqlite3BtreeHoldsAllMutexes(db) );
140 iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977da184232006-01-05 11:34:32 +0000141 assert( iDb>=0 );
drhe6e04962005-07-23 02:17:03 +0000142#ifndef SQLITE_OMIT_AUTHORIZATION
143 if( sqlite3AuthCheck(pParse, SQLITE_ANALYZE, pTab->zName, 0,
dan0f9a34e2009-08-19 16:34:31 +0000144 db->aDb[iDb].zName ) ){
drhe6e04962005-07-23 02:17:03 +0000145 return;
146 }
147#endif
148
danielk1977c00da102006-01-07 13:21:04 +0000149 /* Establish a read-lock on the table at the shared-cache level. */
150 sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
151
danielk19776ab3a2e2009-02-19 14:39:25 +0000152 iIdxCur = pParse->nTab++;
drhff2d5ea2005-07-23 00:41:48 +0000153 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
dane275dc32009-08-18 16:24:58 +0000154 int nCol = pIdx->nColumn;
danielk1977b3bf5562006-01-10 17:58:23 +0000155 KeyInfo *pKey = sqlite3IndexKeyinfo(pParse, pIdx);
156
dane275dc32009-08-18 16:24:58 +0000157 if( iMem+1+(nCol*2)>pParse->nMem ){
158 pParse->nMem = iMem+1+(nCol*2);
159 }
160
161 /* Open a cursor to the index to be analyzed. */
dan0f9a34e2009-08-19 16:34:31 +0000162 assert( iDb==sqlite3SchemaToIndex(db, pIdx->pSchema) );
danielk1977207872a2008-01-03 07:54:23 +0000163 sqlite3VdbeAddOp4(v, OP_OpenRead, iIdxCur, pIdx->tnum, iDb,
drh66a51672008-01-03 00:01:23 +0000164 (char *)pKey, P4_KEYINFO_HANDOFF);
danielk1977207872a2008-01-03 07:54:23 +0000165 VdbeComment((v, "%s", pIdx->zName));
drhff2d5ea2005-07-23 00:41:48 +0000166
dan69188d92009-08-19 08:18:32 +0000167 /* Populate the registers containing the table and index names. */
168 if( pTab->pIndex==pIdx ){
169 sqlite3VdbeAddOp4(v, OP_String8, 0, regTabname, 0, pTab->zName, 0);
170 }
171 sqlite3VdbeAddOp4(v, OP_String8, 0, regIdxname, 0, pIdx->zName, 0);
172
173#ifdef SQLITE_ENABLE_STAT2
dan68c4dbb2009-08-20 09:11:06 +0000174
dane275dc32009-08-18 16:24:58 +0000175 /* If this iteration of the loop is generating code to analyze the
dan68c4dbb2009-08-20 09:11:06 +0000176 ** first index in the pTab->pIndex list, then register regLast has
dane275dc32009-08-18 16:24:58 +0000177 ** not been populated. In this case populate it now. */
dan02fa4692009-08-17 17:06:58 +0000178 if( pTab->pIndex==pIdx ){
dan68c4dbb2009-08-20 09:11:06 +0000179 sqlite3VdbeAddOp2(v, OP_Integer, SQLITE_INDEX_SAMPLES, regSamplerecno);
180 sqlite3VdbeAddOp2(v, OP_Integer, SQLITE_INDEX_SAMPLES*2-1, regTemp);
181 sqlite3VdbeAddOp2(v, OP_Integer, SQLITE_INDEX_SAMPLES*2, regTemp2);
182
183 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur, regLast);
184 sqlite3VdbeAddOp2(v, OP_Null, 0, regFirst);
185 addr = sqlite3VdbeAddOp3(v, OP_Lt, regSamplerecno, 0, regLast);
186 sqlite3VdbeAddOp3(v, OP_Divide, regTemp2, regLast, regFirst);
187 sqlite3VdbeAddOp3(v, OP_Multiply, regLast, regTemp, regLast);
188 sqlite3VdbeAddOp2(v, OP_AddImm, regLast, SQLITE_INDEX_SAMPLES*2-2);
189 sqlite3VdbeAddOp3(v, OP_Divide, regTemp2, regLast, regLast);
190 sqlite3VdbeJumpHere(v, addr);
dan02fa4692009-08-17 17:06:58 +0000191 }
dane275dc32009-08-18 16:24:58 +0000192
193 /* Zero the regSampleno and regRecno registers. */
194 sqlite3VdbeAddOp2(v, OP_Integer, 0, regSampleno);
195 sqlite3VdbeAddOp2(v, OP_Integer, 0, regRecno);
dan68c4dbb2009-08-20 09:11:06 +0000196 sqlite3VdbeAddOp2(v, OP_Copy, regFirst, regSamplerecno);
dan69188d92009-08-19 08:18:32 +0000197#endif
dan02fa4692009-08-17 17:06:58 +0000198
dan85c165c2009-08-19 14:34:54 +0000199 /* The block of memory cells initialized here is used as follows.
drhff2d5ea2005-07-23 00:41:48 +0000200 **
dan85c165c2009-08-19 14:34:54 +0000201 ** iMem:
202 ** The total number of rows in the table.
dan02fa4692009-08-17 17:06:58 +0000203 **
dan85c165c2009-08-19 14:34:54 +0000204 ** iMem+1 .. iMem+nCol:
205 ** Number of distinct entries in index considering the
206 ** left-most N columns only, where N is between 1 and nCol,
207 ** inclusive.
dan02fa4692009-08-17 17:06:58 +0000208 **
dan85c165c2009-08-19 14:34:54 +0000209 ** iMem+nCol+1 .. Mem+2*nCol:
210 ** Previous value of indexed columns, from left to right.
dan02fa4692009-08-17 17:06:58 +0000211 **
dan85c165c2009-08-19 14:34:54 +0000212 ** Cells iMem through iMem+nCol are initialized to 0. The others are
213 ** initialized to contain an SQL NULL.
drhff2d5ea2005-07-23 00:41:48 +0000214 */
drhff2d5ea2005-07-23 00:41:48 +0000215 for(i=0; i<=nCol; i++){
drh4c583122008-01-04 22:01:03 +0000216 sqlite3VdbeAddOp2(v, OP_Integer, 0, iMem+i);
drhff2d5ea2005-07-23 00:41:48 +0000217 }
drhff2d5ea2005-07-23 00:41:48 +0000218 for(i=0; i<nCol; i++){
drh4c583122008-01-04 22:01:03 +0000219 sqlite3VdbeAddOp2(v, OP_Null, 0, iMem+nCol+i+1);
drhff2d5ea2005-07-23 00:41:48 +0000220 }
221
dane275dc32009-08-18 16:24:58 +0000222 /* Start the analysis loop. This loop runs through all the entries in
dan02fa4692009-08-17 17:06:58 +0000223 ** the index b-tree. */
drhff2d5ea2005-07-23 00:41:48 +0000224 endOfLoop = sqlite3VdbeMakeLabel(v);
drh66a51672008-01-03 00:01:23 +0000225 sqlite3VdbeAddOp2(v, OP_Rewind, iIdxCur, endOfLoop);
drhe6e04962005-07-23 02:17:03 +0000226 topOfLoop = sqlite3VdbeCurrentAddr(v);
drh8558cde2008-01-05 05:20:10 +0000227 sqlite3VdbeAddOp2(v, OP_AddImm, iMem, 1);
dan02fa4692009-08-17 17:06:58 +0000228
drhff2d5ea2005-07-23 00:41:48 +0000229 for(i=0; i<nCol; i++){
drh2d401ab2008-01-10 23:50:11 +0000230 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, regCol);
dan69188d92009-08-19 08:18:32 +0000231#ifdef SQLITE_ENABLE_STAT2
dan02fa4692009-08-17 17:06:58 +0000232 if( i==0 ){
dane275dc32009-08-18 16:24:58 +0000233 /* Check if the record that cursor iIdxCur points to contains a
234 ** value that should be stored in the sqlite_stat2 table. If so,
235 ** store it. */
236 int ne = sqlite3VdbeAddOp3(v, OP_Ne, regRecno, 0, regSamplerecno);
237 assert( regTabname+1==regIdxname
238 && regTabname+2==regSampleno
239 && regTabname+3==regCol
240 );
dan68c4dbb2009-08-20 09:11:06 +0000241 sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
dane275dc32009-08-18 16:24:58 +0000242 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 4, regRec, "aaab", 0);
243 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur+1, regRowid);
244 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur+1, regRec, regRowid);
245
246 /* Calculate new values for regSamplerecno and regSampleno.
247 **
248 ** sampleno = sampleno + 1
249 ** samplerecno = samplerecno+(remaining records)/(remaining samples)
250 */
251 sqlite3VdbeAddOp2(v, OP_AddImm, regSampleno, 1);
dan68c4dbb2009-08-20 09:11:06 +0000252 sqlite3VdbeAddOp3(v, OP_Subtract, regRecno, regLast, regTemp);
dane275dc32009-08-18 16:24:58 +0000253 sqlite3VdbeAddOp2(v, OP_AddImm, regTemp, -1);
254 sqlite3VdbeAddOp2(v, OP_Integer, SQLITE_INDEX_SAMPLES, regTemp2);
255 sqlite3VdbeAddOp3(v, OP_Subtract, regSampleno, regTemp2, regTemp2);
256 sqlite3VdbeAddOp3(v, OP_Divide, regTemp2, regTemp, regTemp);
257 sqlite3VdbeAddOp3(v, OP_Add, regSamplerecno, regTemp, regSamplerecno);
258
259 sqlite3VdbeJumpHere(v, ne);
260 sqlite3VdbeAddOp2(v, OP_AddImm, regRecno, 1);
dan02fa4692009-08-17 17:06:58 +0000261 }
dan69188d92009-08-19 08:18:32 +0000262#endif
263
drh2d401ab2008-01-10 23:50:11 +0000264 sqlite3VdbeAddOp3(v, OP_Ne, regCol, 0, iMem+nCol+i+1);
265 /**** TODO: add collating sequence *****/
drh35573352008-01-08 23:54:25 +0000266 sqlite3VdbeChangeP5(v, SQLITE_JUMPIFNULL);
drhff2d5ea2005-07-23 00:41:48 +0000267 }
dan0f9a34e2009-08-19 16:34:31 +0000268 if( db->mallocFailed ){
269 /* If a malloc failure has occurred, then the result of the expression
270 ** passed as the second argument to the call to sqlite3VdbeJumpHere()
271 ** below may be negative. Which causes an assert() to fail (or an
272 ** out-of-bounds write if SQLITE_DEBUG is not defined). */
273 return;
274 }
drh66a51672008-01-03 00:01:23 +0000275 sqlite3VdbeAddOp2(v, OP_Goto, 0, endOfLoop);
drhff2d5ea2005-07-23 00:41:48 +0000276 for(i=0; i<nCol; i++){
dan85c165c2009-08-19 14:34:54 +0000277 sqlite3VdbeJumpHere(v, sqlite3VdbeCurrentAddr(v)-(nCol*2));
drh2d401ab2008-01-10 23:50:11 +0000278 sqlite3VdbeAddOp2(v, OP_AddImm, iMem+i+1, 1);
drhb1fdb2a2008-01-05 04:06:03 +0000279 sqlite3VdbeAddOp3(v, OP_Column, iIdxCur, i, iMem+nCol+i+1);
drhff2d5ea2005-07-23 00:41:48 +0000280 }
dan02fa4692009-08-17 17:06:58 +0000281
282 /* End of the analysis loop. */
drhff2d5ea2005-07-23 00:41:48 +0000283 sqlite3VdbeResolveLabel(v, endOfLoop);
drh66a51672008-01-03 00:01:23 +0000284 sqlite3VdbeAddOp2(v, OP_Next, iIdxCur, topOfLoop);
285 sqlite3VdbeAddOp1(v, OP_Close, iIdxCur);
drhff2d5ea2005-07-23 00:41:48 +0000286
dan02fa4692009-08-17 17:06:58 +0000287 /* Store the results in sqlite_stat1.
drhff2d5ea2005-07-23 00:41:48 +0000288 **
drh4c103832007-06-20 13:37:31 +0000289 ** The result is a single row of the sqlite_stat1 table. The first
drhff2d5ea2005-07-23 00:41:48 +0000290 ** two columns are the names of the table and index. The third column
291 ** is a string composed of a list of integer statistics about the
danielk19772f886d12009-02-28 10:47:41 +0000292 ** index. The first integer in the list is the total number of entries
drh17a18f22005-07-23 14:52:12 +0000293 ** in the index. There is one additional integer in the list for each
294 ** column of the table. This additional integer is a guess of how many
295 ** rows of the table the index will select. If D is the count of distinct
296 ** values and K is the total number of rows, then the integer is computed
297 ** as:
drhff2d5ea2005-07-23 00:41:48 +0000298 **
299 ** I = (K+D-1)/D
300 **
301 ** If K==0 then no entry is made into the sqlite_stat1 table.
302 ** If K>0 then it is always the case the D>0 so division by zero
303 ** is never possible.
304 */
drh2d401ab2008-01-10 23:50:11 +0000305 addr = sqlite3VdbeAddOp1(v, OP_IfNot, iMem);
dane275dc32009-08-18 16:24:58 +0000306 sqlite3VdbeAddOp2(v, OP_SCopy, iMem, regSampleno);
drhff2d5ea2005-07-23 00:41:48 +0000307 for(i=0; i<nCol; i++){
drh2d401ab2008-01-10 23:50:11 +0000308 sqlite3VdbeAddOp4(v, OP_String8, 0, regTemp, 0, " ", 0);
dane275dc32009-08-18 16:24:58 +0000309 sqlite3VdbeAddOp3(v, OP_Concat, regTemp, regSampleno, regSampleno);
drh2d401ab2008-01-10 23:50:11 +0000310 sqlite3VdbeAddOp3(v, OP_Add, iMem, iMem+i+1, regTemp);
311 sqlite3VdbeAddOp2(v, OP_AddImm, regTemp, -1);
312 sqlite3VdbeAddOp3(v, OP_Divide, iMem+i+1, regTemp, regTemp);
313 sqlite3VdbeAddOp1(v, OP_ToInt, regTemp);
dane275dc32009-08-18 16:24:58 +0000314 sqlite3VdbeAddOp3(v, OP_Concat, regTemp, regSampleno, regSampleno);
drhff2d5ea2005-07-23 00:41:48 +0000315 }
dane275dc32009-08-18 16:24:58 +0000316 sqlite3VdbeAddOp4(v, OP_MakeRecord, regTabname, 3, regRec, "aaa", 0);
drh2d401ab2008-01-10 23:50:11 +0000317 sqlite3VdbeAddOp2(v, OP_NewRowid, iStatCur, regRowid);
318 sqlite3VdbeAddOp3(v, OP_Insert, iStatCur, regRec, regRowid);
319 sqlite3VdbeChangeP5(v, OPFLAG_APPEND);
drhd654be82005-09-20 17:42:23 +0000320 sqlite3VdbeJumpHere(v, addr);
drhff2d5ea2005-07-23 00:41:48 +0000321 }
322}
323
324/*
drh497e4462005-07-23 03:18:40 +0000325** Generate code that will cause the most recent index analysis to
326** be laoded into internal hash tables where is can be used.
327*/
328static void loadAnalysis(Parse *pParse, int iDb){
329 Vdbe *v = sqlite3GetVdbe(pParse);
drhcf1be452007-05-12 12:08:51 +0000330 if( v ){
drh66a51672008-01-03 00:01:23 +0000331 sqlite3VdbeAddOp1(v, OP_LoadAnalysis, iDb);
drhcf1be452007-05-12 12:08:51 +0000332 }
drh497e4462005-07-23 03:18:40 +0000333}
334
335/*
drhff2d5ea2005-07-23 00:41:48 +0000336** Generate code that will do an analysis of an entire database
337*/
338static void analyzeDatabase(Parse *pParse, int iDb){
339 sqlite3 *db = pParse->db;
danielk1977e501b892006-01-09 06:29:47 +0000340 Schema *pSchema = db->aDb[iDb].pSchema; /* Schema of database iDb */
drhff2d5ea2005-07-23 00:41:48 +0000341 HashElem *k;
342 int iStatCur;
343 int iMem;
344
345 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +0000346 iStatCur = pParse->nTab;
347 pParse->nTab += 2;
drhff2d5ea2005-07-23 00:41:48 +0000348 openStatTable(pParse, iDb, iStatCur, 0);
drh0a07c102008-01-03 18:03:08 +0000349 iMem = pParse->nMem+1;
danielk1977da184232006-01-05 11:34:32 +0000350 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
drhff2d5ea2005-07-23 00:41:48 +0000351 Table *pTab = (Table*)sqliteHashData(k);
352 analyzeOneTable(pParse, pTab, iStatCur, iMem);
353 }
drh497e4462005-07-23 03:18:40 +0000354 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +0000355}
356
357/*
358** Generate code that will do an analysis of a single table in
359** a database.
360*/
361static void analyzeTable(Parse *pParse, Table *pTab){
362 int iDb;
363 int iStatCur;
364
365 assert( pTab!=0 );
drh1fee73e2007-08-29 04:00:57 +0000366 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
danielk1977da184232006-01-05 11:34:32 +0000367 iDb = sqlite3SchemaToIndex(pParse->db, pTab->pSchema);
drhff2d5ea2005-07-23 00:41:48 +0000368 sqlite3BeginWriteOperation(pParse, 0, iDb);
dan02fa4692009-08-17 17:06:58 +0000369 iStatCur = pParse->nTab;
370 pParse->nTab += 2;
drhff2d5ea2005-07-23 00:41:48 +0000371 openStatTable(pParse, iDb, iStatCur, pTab->zName);
drh0a07c102008-01-03 18:03:08 +0000372 analyzeOneTable(pParse, pTab, iStatCur, pParse->nMem+1);
drh497e4462005-07-23 03:18:40 +0000373 loadAnalysis(pParse, iDb);
drhff2d5ea2005-07-23 00:41:48 +0000374}
375
376/*
377** Generate code for the ANALYZE command. The parser calls this routine
378** when it recognizes an ANALYZE command.
drh9f18e8a2005-07-08 12:13:04 +0000379**
380** ANALYZE -- 1
drhff2d5ea2005-07-23 00:41:48 +0000381** ANALYZE <database> -- 2
drh9f18e8a2005-07-08 12:13:04 +0000382** ANALYZE ?<database>.?<tablename> -- 3
383**
384** Form 1 causes all indices in all attached databases to be analyzed.
385** Form 2 analyzes all indices the single database named.
386** Form 3 analyzes all indices associated with the named table.
387*/
388void sqlite3Analyze(Parse *pParse, Token *pName1, Token *pName2){
drhff2d5ea2005-07-23 00:41:48 +0000389 sqlite3 *db = pParse->db;
390 int iDb;
391 int i;
392 char *z, *zDb;
393 Table *pTab;
394 Token *pTableName;
395
396 /* Read the database schema. If an error occurs, leave an error message
397 ** and code in pParse and return NULL. */
drh1fee73e2007-08-29 04:00:57 +0000398 assert( sqlite3BtreeHoldsAllMutexes(pParse->db) );
drhff2d5ea2005-07-23 00:41:48 +0000399 if( SQLITE_OK!=sqlite3ReadSchema(pParse) ){
400 return;
401 }
402
drh05800a12009-04-16 17:45:47 +0000403 assert( pName2!=0 || pName1==0 );
drhff2d5ea2005-07-23 00:41:48 +0000404 if( pName1==0 ){
405 /* Form 1: Analyze everything */
406 for(i=0; i<db->nDb; i++){
407 if( i==1 ) continue; /* Do not analyze the TEMP database */
408 analyzeDatabase(pParse, i);
409 }
drh05800a12009-04-16 17:45:47 +0000410 }else if( pName2->n==0 ){
drhff2d5ea2005-07-23 00:41:48 +0000411 /* Form 2: Analyze the database or table named */
412 iDb = sqlite3FindDb(db, pName1);
413 if( iDb>=0 ){
414 analyzeDatabase(pParse, iDb);
drhe6e04962005-07-23 02:17:03 +0000415 }else{
drh17435752007-08-16 04:30:38 +0000416 z = sqlite3NameFromToken(db, pName1);
danielk1977b8b4bfa2007-11-15 13:10:22 +0000417 if( z ){
drhca424112008-01-25 15:04:48 +0000418 pTab = sqlite3LocateTable(pParse, 0, z, 0);
drh633e6d52008-07-28 19:34:53 +0000419 sqlite3DbFree(db, z);
danielk1977b8b4bfa2007-11-15 13:10:22 +0000420 if( pTab ){
421 analyzeTable(pParse, pTab);
422 }
drhe6e04962005-07-23 02:17:03 +0000423 }
drhff2d5ea2005-07-23 00:41:48 +0000424 }
drhff2d5ea2005-07-23 00:41:48 +0000425 }else{
426 /* Form 3: Analyze the fully qualified table name */
427 iDb = sqlite3TwoPartName(pParse, pName1, pName2, &pTableName);
428 if( iDb>=0 ){
429 zDb = db->aDb[iDb].zName;
drh17435752007-08-16 04:30:38 +0000430 z = sqlite3NameFromToken(db, pTableName);
drhcf1be452007-05-12 12:08:51 +0000431 if( z ){
drhca424112008-01-25 15:04:48 +0000432 pTab = sqlite3LocateTable(pParse, 0, z, zDb);
drh633e6d52008-07-28 19:34:53 +0000433 sqlite3DbFree(db, z);
drhcf1be452007-05-12 12:08:51 +0000434 if( pTab ){
435 analyzeTable(pParse, pTab);
436 }
drhff2d5ea2005-07-23 00:41:48 +0000437 }
438 }
439 }
drh9f18e8a2005-07-08 12:13:04 +0000440}
441
drh497e4462005-07-23 03:18:40 +0000442/*
443** Used to pass information from the analyzer reader through to the
444** callback routine.
445*/
446typedef struct analysisInfo analysisInfo;
447struct analysisInfo {
448 sqlite3 *db;
449 const char *zDatabase;
450};
451
452/*
453** This callback is invoked once for each index when reading the
454** sqlite_stat1 table.
455**
456** argv[0] = name of the index
457** argv[1] = results of analysis - on integer for each column
458*/
danielk197762c14b32008-11-19 09:05:26 +0000459static int analysisLoader(void *pData, int argc, char **argv, char **NotUsed){
drh497e4462005-07-23 03:18:40 +0000460 analysisInfo *pInfo = (analysisInfo*)pData;
461 Index *pIndex;
462 int i, c;
463 unsigned int v;
464 const char *z;
465
466 assert( argc==2 );
danielk1977f3d3c272008-11-19 16:52:44 +0000467 UNUSED_PARAMETER2(NotUsed, argc);
468
drh1ec43c92005-09-06 10:26:47 +0000469 if( argv==0 || argv[0]==0 || argv[1]==0 ){
drh497e4462005-07-23 03:18:40 +0000470 return 0;
471 }
472 pIndex = sqlite3FindIndex(pInfo->db, argv[0], pInfo->zDatabase);
473 if( pIndex==0 ){
474 return 0;
475 }
476 z = argv[1];
drh17a18f22005-07-23 14:52:12 +0000477 for(i=0; *z && i<=pIndex->nColumn; i++){
drh497e4462005-07-23 03:18:40 +0000478 v = 0;
479 while( (c=z[0])>='0' && c<='9' ){
480 v = v*10 + c - '0';
481 z++;
482 }
483 pIndex->aiRowEst[i] = v;
484 if( *z==' ' ) z++;
485 }
486 return 0;
487}
488
489/*
dan85c165c2009-08-19 14:34:54 +0000490** If the Index.aSample variable is not NULL, delete the aSample[] array
491** and its contents.
492*/
dand46def72010-07-24 11:28:28 +0000493void sqlite3DeleteIndexSamples(sqlite3 *db, Index *pIdx){
dan85c165c2009-08-19 14:34:54 +0000494#ifdef SQLITE_ENABLE_STAT2
495 if( pIdx->aSample ){
496 int j;
dan85c165c2009-08-19 14:34:54 +0000497 for(j=0; j<SQLITE_INDEX_SAMPLES; j++){
498 IndexSample *p = &pIdx->aSample[j];
499 if( p->eType==SQLITE_TEXT || p->eType==SQLITE_BLOB ){
dand46def72010-07-24 11:28:28 +0000500 sqlite3DbFree(db, p->u.z);
dan85c165c2009-08-19 14:34:54 +0000501 }
502 }
dand46def72010-07-24 11:28:28 +0000503 sqlite3DbFree(db, pIdx->aSample);
dan85c165c2009-08-19 14:34:54 +0000504 }
shanecea72b22009-09-07 04:38:36 +0000505#else
506 UNUSED_PARAMETER(pIdx);
dan85c165c2009-08-19 14:34:54 +0000507#endif
508}
509
510/*
511** Load the content of the sqlite_stat1 and sqlite_stat2 tables. The
512** contents of sqlite_stat1 are used to populate the Index.aiRowEst[]
513** arrays. The contents of sqlite_stat2 are used to populate the
514** Index.aSample[] arrays.
515**
516** If the sqlite_stat1 table is not present in the database, SQLITE_ERROR
517** is returned. In this case, even if SQLITE_ENABLE_STAT2 was defined
518** during compilation and the sqlite_stat2 table is present, no data is
519** read from it.
520**
521** If SQLITE_ENABLE_STAT2 was defined during compilation and the
522** sqlite_stat2 table is not present in the database, SQLITE_ERROR is
523** returned. However, in this case, data is read from the sqlite_stat1
524** table (if it is present) before returning.
525**
526** If an OOM error occurs, this function always sets db->mallocFailed.
527** This means if the caller does not care about other errors, the return
528** code may be ignored.
drh497e4462005-07-23 03:18:40 +0000529*/
drhcf1be452007-05-12 12:08:51 +0000530int sqlite3AnalysisLoad(sqlite3 *db, int iDb){
drh497e4462005-07-23 03:18:40 +0000531 analysisInfo sInfo;
532 HashElem *i;
533 char *zSql;
drhcf1be452007-05-12 12:08:51 +0000534 int rc;
drh497e4462005-07-23 03:18:40 +0000535
drhff0587c2007-08-29 17:43:19 +0000536 assert( iDb>=0 && iDb<db->nDb );
537 assert( db->aDb[iDb].pBt!=0 );
538 assert( sqlite3BtreeHoldsMutex(db->aDb[iDb].pBt) );
drh1fee73e2007-08-29 04:00:57 +0000539
drh497e4462005-07-23 03:18:40 +0000540 /* Clear any prior statistics */
danielk1977da184232006-01-05 11:34:32 +0000541 for(i=sqliteHashFirst(&db->aDb[iDb].pSchema->idxHash);i;i=sqliteHashNext(i)){
drh497e4462005-07-23 03:18:40 +0000542 Index *pIdx = sqliteHashData(i);
drh51147ba2005-07-23 22:59:55 +0000543 sqlite3DefaultRowEst(pIdx);
dand46def72010-07-24 11:28:28 +0000544 sqlite3DeleteIndexSamples(db, pIdx);
545 pIdx->aSample = 0;
drh497e4462005-07-23 03:18:40 +0000546 }
547
dan85c165c2009-08-19 14:34:54 +0000548 /* Check to make sure the sqlite_stat1 table exists */
drh497e4462005-07-23 03:18:40 +0000549 sInfo.db = db;
550 sInfo.zDatabase = db->aDb[iDb].zName;
551 if( sqlite3FindTable(db, "sqlite_stat1", sInfo.zDatabase)==0 ){
dan85c165c2009-08-19 14:34:54 +0000552 return SQLITE_ERROR;
drh497e4462005-07-23 03:18:40 +0000553 }
554
drh497e4462005-07-23 03:18:40 +0000555 /* Load new statistics out of the sqlite_stat1 table */
dan85c165c2009-08-19 14:34:54 +0000556 zSql = sqlite3MPrintf(db,
557 "SELECT idx, stat FROM %Q.sqlite_stat1", sInfo.zDatabase);
drhf16ce3b2009-02-13 16:59:53 +0000558 if( zSql==0 ){
559 rc = SQLITE_NOMEM;
560 }else{
drhf16ce3b2009-02-13 16:59:53 +0000561 rc = sqlite3_exec(db, zSql, analysisLoader, &sInfo, 0);
drhf16ce3b2009-02-13 16:59:53 +0000562 sqlite3DbFree(db, zSql);
drhf16ce3b2009-02-13 16:59:53 +0000563 }
dan02fa4692009-08-17 17:06:58 +0000564
dan85c165c2009-08-19 14:34:54 +0000565
dane275dc32009-08-18 16:24:58 +0000566 /* Load the statistics from the sqlite_stat2 table. */
dan69188d92009-08-19 08:18:32 +0000567#ifdef SQLITE_ENABLE_STAT2
dan85c165c2009-08-19 14:34:54 +0000568 if( rc==SQLITE_OK && !sqlite3FindTable(db, "sqlite_stat2", sInfo.zDatabase) ){
569 rc = SQLITE_ERROR;
570 }
dan02fa4692009-08-17 17:06:58 +0000571 if( rc==SQLITE_OK ){
dane275dc32009-08-18 16:24:58 +0000572 sqlite3_stmt *pStmt = 0;
573
dan02fa4692009-08-17 17:06:58 +0000574 zSql = sqlite3MPrintf(db,
dan85c165c2009-08-19 14:34:54 +0000575 "SELECT idx,sampleno,sample FROM %Q.sqlite_stat2", sInfo.zDatabase);
dane275dc32009-08-18 16:24:58 +0000576 if( !zSql ){
dan85c165c2009-08-19 14:34:54 +0000577 rc = SQLITE_NOMEM;
578 }else{
dan85c165c2009-08-19 14:34:54 +0000579 rc = sqlite3_prepare(db, zSql, -1, &pStmt, 0);
dan85c165c2009-08-19 14:34:54 +0000580 sqlite3DbFree(db, zSql);
dan02fa4692009-08-17 17:06:58 +0000581 }
dane275dc32009-08-18 16:24:58 +0000582
dane275dc32009-08-18 16:24:58 +0000583 if( rc==SQLITE_OK ){
584 while( sqlite3_step(pStmt)==SQLITE_ROW ){
585 char *zIndex = (char *)sqlite3_column_text(pStmt, 0);
586 Index *pIdx = sqlite3FindIndex(db, zIndex, sInfo.zDatabase);
587 if( pIdx ){
588 int iSample = sqlite3_column_int(pStmt, 1);
589 if( iSample<SQLITE_INDEX_SAMPLES && iSample>=0 ){
590 int eType = sqlite3_column_type(pStmt, 2);
591
592 if( pIdx->aSample==0 ){
dana898aac2009-08-19 09:09:38 +0000593 static const int sz = sizeof(IndexSample)*SQLITE_INDEX_SAMPLES;
dan1feeaed2010-07-23 15:41:47 +0000594 pIdx->aSample = (IndexSample *)sqlite3Malloc(sz);
dan69188d92009-08-19 08:18:32 +0000595 if( pIdx->aSample==0 ){
dan85c165c2009-08-19 14:34:54 +0000596 db->mallocFailed = 1;
dan69188d92009-08-19 08:18:32 +0000597 break;
598 }
dan1feeaed2010-07-23 15:41:47 +0000599 memset(pIdx->aSample, 0, sz);
dane275dc32009-08-18 16:24:58 +0000600 }
601
drh9e1fade2009-08-20 23:05:31 +0000602 assert( pIdx->aSample );
603 {
dane275dc32009-08-18 16:24:58 +0000604 IndexSample *pSample = &pIdx->aSample[iSample];
shanecea72b22009-09-07 04:38:36 +0000605 pSample->eType = (u8)eType;
dan69188d92009-08-19 08:18:32 +0000606 if( eType==SQLITE_INTEGER || eType==SQLITE_FLOAT ){
dane275dc32009-08-18 16:24:58 +0000607 pSample->u.r = sqlite3_column_double(pStmt, 2);
dan69188d92009-08-19 08:18:32 +0000608 }else if( eType==SQLITE_TEXT || eType==SQLITE_BLOB ){
dane275dc32009-08-18 16:24:58 +0000609 const char *z = (const char *)(
610 (eType==SQLITE_BLOB) ?
611 sqlite3_column_blob(pStmt, 2):
612 sqlite3_column_text(pStmt, 2)
613 );
614 int n = sqlite3_column_bytes(pStmt, 2);
615 if( n>24 ){
616 n = 24;
617 }
shanecea72b22009-09-07 04:38:36 +0000618 pSample->nByte = (u8)n;
shaneh1141ae22010-03-26 01:54:33 +0000619 if( n < 1){
620 pSample->u.z = 0;
dane275dc32009-08-18 16:24:58 +0000621 }else{
dan1feeaed2010-07-23 15:41:47 +0000622 pSample->u.z = sqlite3Malloc(n);
shaneh1141ae22010-03-26 01:54:33 +0000623 if( pSample->u.z ){
624 memcpy(pSample->u.z, z, n);
625 }else{
626 db->mallocFailed = 1;
627 break;
628 }
dan69188d92009-08-19 08:18:32 +0000629 }
dane275dc32009-08-18 16:24:58 +0000630 }
631 }
632 }
633 }
634 }
635 rc = sqlite3_finalize(pStmt);
636 }
dan02fa4692009-08-17 17:06:58 +0000637 }
dan69188d92009-08-19 08:18:32 +0000638#endif
dan02fa4692009-08-17 17:06:58 +0000639
dane275dc32009-08-18 16:24:58 +0000640 if( rc==SQLITE_NOMEM ){
641 db->mallocFailed = 1;
642 }
drhcf1be452007-05-12 12:08:51 +0000643 return rc;
drh497e4462005-07-23 03:18:40 +0000644}
drh9f18e8a2005-07-08 12:13:04 +0000645
drhff2d5ea2005-07-23 00:41:48 +0000646
drh9f18e8a2005-07-08 12:13:04 +0000647#endif /* SQLITE_OMIT_ANALYZE */