blob: 504f51ec0f0c3f085fbb414f15be73b55fb7f48a [file] [log] [blame]
drhc11d4f92003-04-06 21:08:24 +00001/*
2** 2003 April 6
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 used to implement the PRAGMA command.
drhc11d4f92003-04-06 21:08:24 +000013*/
14#include "sqliteInt.h"
15
drh9ccd8652013-09-13 16:36:46 +000016#if !defined(SQLITE_ENABLE_LOCKING_STYLE)
17# if defined(__APPLE__)
18# define SQLITE_ENABLE_LOCKING_STYLE 1
19# else
20# define SQLITE_ENABLE_LOCKING_STYLE 0
21# endif
22#endif
23
24/***************************************************************************
drh67e65e52015-02-02 21:34:54 +000025** The "pragma.h" include file is an automatically generated file that
26** that includes the PragType_XXXX macro definitions and the aPragmaName[]
27** object. This ensures that the aPragmaName[] table is arranged in
28** lexicographical order to facility a binary search of the pragma name.
29** Do not edit pragma.h directly. Edit and rerun the script in at
30** ../tool/mkpragmatab.tcl. */
31#include "pragma.h"
drh9ccd8652013-09-13 16:36:46 +000032
drhc11d4f92003-04-06 21:08:24 +000033/*
drhc11d4f92003-04-06 21:08:24 +000034** Interpret the given string as a safety level. Return 0 for OFF,
drh6841b1c2016-02-03 19:20:15 +000035** 1 for ON or NORMAL, 2 for FULL, and 3 for EXTRA. Return 1 for an empty or
36** unrecognized string argument. The FULL and EXTRA option is disallowed
drh908c0052012-01-30 18:40:55 +000037** if the omitFull parameter it 1.
drhc11d4f92003-04-06 21:08:24 +000038**
39** Note that the values returned are one less that the values that
danielk19774adee202004-05-08 08:23:19 +000040** should be passed into sqlite3BtreeSetSafetyLevel(). The is done
drhc11d4f92003-04-06 21:08:24 +000041** to support legacy SQL code. The safety level used to be boolean
42** and older scripts may have used numbers 0 for OFF and 1 for ON.
43*/
drheac5bd72014-07-25 21:35:39 +000044static u8 getSafetyLevel(const char *z, int omitFull, u8 dflt){
drh6841b1c2016-02-03 19:20:15 +000045 /* 123456789 123456789 123 */
46 static const char zText[] = "onoffalseyestruextrafull";
47 static const u8 iOffset[] = {0, 1, 2, 4, 9, 12, 15, 20};
48 static const u8 iLength[] = {2, 2, 3, 5, 3, 4, 5, 4};
49 static const u8 iValue[] = {1, 0, 0, 0, 1, 1, 3, 2};
50 /* on no off false yes true extra full */
drh722e95a2004-10-25 20:33:44 +000051 int i, n;
danielk197778ca0e72009-01-20 16:53:39 +000052 if( sqlite3Isdigit(*z) ){
drh60ac3f42010-11-23 18:59:27 +000053 return (u8)sqlite3Atoi(z);
drhc11d4f92003-04-06 21:08:24 +000054 }
drhea678832008-12-10 19:26:22 +000055 n = sqlite3Strlen30(z);
drh6841b1c2016-02-03 19:20:15 +000056 for(i=0; i<ArraySize(iLength); i++){
57 if( iLength[i]==n && sqlite3StrNICmp(&zText[iOffset[i]],z,n)==0
58 && (!omitFull || iValue[i]<=1)
59 ){
drh722e95a2004-10-25 20:33:44 +000060 return iValue[i];
61 }
drhc11d4f92003-04-06 21:08:24 +000062 }
drh908c0052012-01-30 18:40:55 +000063 return dflt;
drhc11d4f92003-04-06 21:08:24 +000064}
65
66/*
drh722e95a2004-10-25 20:33:44 +000067** Interpret the given string as a boolean value.
68*/
drheac5bd72014-07-25 21:35:39 +000069u8 sqlite3GetBoolean(const char *z, u8 dflt){
drh38d9c612012-01-31 14:24:47 +000070 return getSafetyLevel(z,1,dflt)!=0;
drh722e95a2004-10-25 20:33:44 +000071}
72
drhc7dc9bf2011-06-03 13:02:57 +000073/* The sqlite3GetBoolean() function is used by other modules but the
74** remainder of this file is specific to PRAGMA processing. So omit
75** the rest of the file if PRAGMAs are omitted from the build.
76*/
77#if !defined(SQLITE_OMIT_PRAGMA)
78
danielk197741483462007-03-24 16:45:04 +000079/*
80** Interpret the given string as a locking mode value.
81*/
82static int getLockingMode(const char *z){
83 if( z ){
84 if( 0==sqlite3StrICmp(z, "exclusive") ) return PAGER_LOCKINGMODE_EXCLUSIVE;
85 if( 0==sqlite3StrICmp(z, "normal") ) return PAGER_LOCKINGMODE_NORMAL;
86 }
87 return PAGER_LOCKINGMODE_QUERY;
88}
89
danielk1977dddbcdc2007-04-26 14:42:34 +000090#ifndef SQLITE_OMIT_AUTOVACUUM
91/*
92** Interpret the given string as an auto-vacuum mode value.
93**
94** The following strings, "none", "full" and "incremental" are
95** acceptable, as are their numeric equivalents: 0, 1 and 2 respectively.
96*/
97static int getAutoVacuum(const char *z){
98 int i;
99 if( 0==sqlite3StrICmp(z, "none") ) return BTREE_AUTOVACUUM_NONE;
100 if( 0==sqlite3StrICmp(z, "full") ) return BTREE_AUTOVACUUM_FULL;
101 if( 0==sqlite3StrICmp(z, "incremental") ) return BTREE_AUTOVACUUM_INCR;
drh60ac3f42010-11-23 18:59:27 +0000102 i = sqlite3Atoi(z);
drh4f21c4a2008-12-10 22:15:00 +0000103 return (u8)((i>=0&&i<=2)?i:0);
danielk1977dddbcdc2007-04-26 14:42:34 +0000104}
105#endif /* ifndef SQLITE_OMIT_AUTOVACUUM */
106
danielk1977b84f96f2005-01-20 11:32:23 +0000107#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh722e95a2004-10-25 20:33:44 +0000108/*
drh90f5ecb2004-07-22 01:19:35 +0000109** Interpret the given string as a temp db location. Return 1 for file
110** backed temporary databases, 2 for the Red-Black tree in memory database
111** and 0 to use the compile-time default.
112*/
113static int getTempStore(const char *z){
114 if( z[0]>='0' && z[0]<='2' ){
115 return z[0] - '0';
116 }else if( sqlite3StrICmp(z, "file")==0 ){
117 return 1;
118 }else if( sqlite3StrICmp(z, "memory")==0 ){
119 return 2;
120 }else{
121 return 0;
122 }
123}
drhbf216272005-02-26 18:10:44 +0000124#endif /* SQLITE_PAGER_PRAGMAS */
drh90f5ecb2004-07-22 01:19:35 +0000125
drhbf216272005-02-26 18:10:44 +0000126#ifndef SQLITE_OMIT_PAGER_PRAGMAS
drh90f5ecb2004-07-22 01:19:35 +0000127/*
tpoindex9a09a3c2004-12-20 19:01:32 +0000128** Invalidate temp storage, either when the temp storage is changed
129** from default, or when 'file' and the temp_store_directory has changed
drh90f5ecb2004-07-22 01:19:35 +0000130*/
tpoindex9a09a3c2004-12-20 19:01:32 +0000131static int invalidateTempStorage(Parse *pParse){
drh9bb575f2004-09-06 17:24:11 +0000132 sqlite3 *db = pParse->db;
drh90f5ecb2004-07-22 01:19:35 +0000133 if( db->aDb[1].pBt!=0 ){
danielk1977983e2302008-07-08 07:35:51 +0000134 if( !db->autoCommit || sqlite3BtreeIsInReadTrans(db->aDb[1].pBt) ){
drh90f5ecb2004-07-22 01:19:35 +0000135 sqlite3ErrorMsg(pParse, "temporary storage cannot be changed "
136 "from within a transaction");
137 return SQLITE_ERROR;
138 }
139 sqlite3BtreeClose(db->aDb[1].pBt);
140 db->aDb[1].pBt = 0;
drh81028a42012-05-15 18:28:27 +0000141 sqlite3ResetAllSchemasOfConnection(db);
drh90f5ecb2004-07-22 01:19:35 +0000142 }
tpoindex9a09a3c2004-12-20 19:01:32 +0000143 return SQLITE_OK;
144}
drhbf216272005-02-26 18:10:44 +0000145#endif /* SQLITE_PAGER_PRAGMAS */
tpoindex9a09a3c2004-12-20 19:01:32 +0000146
drhbf216272005-02-26 18:10:44 +0000147#ifndef SQLITE_OMIT_PAGER_PRAGMAS
tpoindex9a09a3c2004-12-20 19:01:32 +0000148/*
149** If the TEMP database is open, close it and mark the database schema
danielk1977b06a0b62008-06-26 10:54:12 +0000150** as needing reloading. This must be done when using the SQLITE_TEMP_STORE
tpoindex9a09a3c2004-12-20 19:01:32 +0000151** or DEFAULT_TEMP_STORE pragmas.
152*/
153static int changeTempStorage(Parse *pParse, const char *zStorageType){
154 int ts = getTempStore(zStorageType);
155 sqlite3 *db = pParse->db;
156 if( db->temp_store==ts ) return SQLITE_OK;
157 if( invalidateTempStorage( pParse ) != SQLITE_OK ){
158 return SQLITE_ERROR;
159 }
drh4f21c4a2008-12-10 22:15:00 +0000160 db->temp_store = (u8)ts;
drh90f5ecb2004-07-22 01:19:35 +0000161 return SQLITE_OK;
162}
drhbf216272005-02-26 18:10:44 +0000163#endif /* SQLITE_PAGER_PRAGMAS */
drh90f5ecb2004-07-22 01:19:35 +0000164
165/*
drhc232aca2016-12-15 16:01:17 +0000166** Set result column names for a pragma.
drhb460e522015-09-03 03:29:51 +0000167*/
drhc232aca2016-12-15 16:01:17 +0000168static void setPragmaResultColumnNames(
drh2fcc1592016-12-15 20:59:03 +0000169 Vdbe *v, /* The query under construction */
170 const PragmaName *pPragma /* The pragma */
drhb460e522015-09-03 03:29:51 +0000171){
drhc232aca2016-12-15 16:01:17 +0000172 u8 n = pPragma->nPragCName;
173 sqlite3VdbeSetNumCols(v, n==0 ? 1 : n);
174 if( n==0 ){
175 sqlite3VdbeSetColName(v, 0, COLNAME_NAME, pPragma->zName, SQLITE_STATIC);
176 }else{
177 int i, j;
178 for(i=0, j=pPragma->iPragCName; i<n; i++, j++){
179 sqlite3VdbeSetColName(v, i, COLNAME_NAME, pragCName[j], SQLITE_STATIC);
180 }
drhb460e522015-09-03 03:29:51 +0000181 }
182}
drhb460e522015-09-03 03:29:51 +0000183
184/*
drh90f5ecb2004-07-22 01:19:35 +0000185** Generate code to return a single integer value.
186*/
drhc232aca2016-12-15 16:01:17 +0000187static void returnSingleInt(Vdbe *v, i64 value){
drh7cc023c2015-09-03 04:28:25 +0000188 sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, 1, 0, (const u8*)&value, P4_INT64);
drh7cc023c2015-09-03 04:28:25 +0000189 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
190}
191
192/*
193** Generate code to return a single text value.
194*/
195static void returnSingleText(
196 Vdbe *v, /* Prepared statement under construction */
drh7cc023c2015-09-03 04:28:25 +0000197 const char *zValue /* Value to be returned */
198){
199 if( zValue ){
drh076e85f2015-09-03 13:46:12 +0000200 sqlite3VdbeLoadString(v, 1, (const char*)zValue);
drh7cc023c2015-09-03 04:28:25 +0000201 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
202 }
drh90f5ecb2004-07-22 01:19:35 +0000203}
204
drhd3605a42013-08-17 15:42:29 +0000205
206/*
207** Set the safety_level and pager flags for pager iDb. Or if iDb<0
208** set these values for all pagers.
209*/
210#ifndef SQLITE_OMIT_PAGER_PRAGMAS
211static void setAllPagerFlags(sqlite3 *db){
212 if( db->autoCommit ){
213 Db *pDb = db->aDb;
214 int n = db->nDb;
215 assert( SQLITE_FullFSync==PAGER_FULLFSYNC );
216 assert( SQLITE_CkptFullFSync==PAGER_CKPT_FULLFSYNC );
217 assert( SQLITE_CacheSpill==PAGER_CACHESPILL );
218 assert( (PAGER_FULLFSYNC | PAGER_CKPT_FULLFSYNC | PAGER_CACHESPILL)
219 == PAGER_FLAGS_MASK );
220 assert( (pDb->safety_level & PAGER_SYNCHRONOUS_MASK)==pDb->safety_level );
221 while( (n--) > 0 ){
222 if( pDb->pBt ){
223 sqlite3BtreeSetPagerFlags(pDb->pBt,
224 pDb->safety_level | (db->flags & PAGER_FLAGS_MASK) );
225 }
226 pDb++;
227 }
228 }
229}
drhfeb56e02013-08-23 17:33:46 +0000230#else
231# define setAllPagerFlags(X) /* no-op */
drhd3605a42013-08-17 15:42:29 +0000232#endif
233
234
drhd2cb50b2009-01-09 21:41:17 +0000235/*
236** Return a human-readable name for a constraint resolution action.
237*/
danba9108b2009-09-22 07:13:42 +0000238#ifndef SQLITE_OMIT_FOREIGN_KEY
danielk197750af3e12008-10-10 17:47:21 +0000239static const char *actionName(u8 action){
drhd2cb50b2009-01-09 21:41:17 +0000240 const char *zName;
danielk197750af3e12008-10-10 17:47:21 +0000241 switch( action ){
dan1da40a32009-09-19 17:00:31 +0000242 case OE_SetNull: zName = "SET NULL"; break;
243 case OE_SetDflt: zName = "SET DEFAULT"; break;
244 case OE_Cascade: zName = "CASCADE"; break;
245 case OE_Restrict: zName = "RESTRICT"; break;
246 default: zName = "NO ACTION";
247 assert( action==OE_None ); break;
danielk197750af3e12008-10-10 17:47:21 +0000248 }
drhd2cb50b2009-01-09 21:41:17 +0000249 return zName;
danielk197750af3e12008-10-10 17:47:21 +0000250}
danba9108b2009-09-22 07:13:42 +0000251#endif
danielk197750af3e12008-10-10 17:47:21 +0000252
dane04dc882010-04-20 18:53:15 +0000253
254/*
255** Parameter eMode must be one of the PAGER_JOURNALMODE_XXX constants
256** defined in pager.h. This function returns the associated lowercase
257** journal-mode name.
258*/
259const char *sqlite3JournalModename(int eMode){
260 static char * const azModeName[] = {
dan5cf53532010-05-01 16:40:20 +0000261 "delete", "persist", "off", "truncate", "memory"
262#ifndef SQLITE_OMIT_WAL
263 , "wal"
264#endif
dane04dc882010-04-20 18:53:15 +0000265 };
266 assert( PAGER_JOURNALMODE_DELETE==0 );
267 assert( PAGER_JOURNALMODE_PERSIST==1 );
268 assert( PAGER_JOURNALMODE_OFF==2 );
269 assert( PAGER_JOURNALMODE_TRUNCATE==3 );
270 assert( PAGER_JOURNALMODE_MEMORY==4 );
271 assert( PAGER_JOURNALMODE_WAL==5 );
272 assert( eMode>=0 && eMode<=ArraySize(azModeName) );
273
274 if( eMode==ArraySize(azModeName) ) return 0;
275 return azModeName[eMode];
276}
277
drh87223182004-02-21 14:00:29 +0000278/*
drh2fcc1592016-12-15 20:59:03 +0000279** Locate a pragma in the aPragmaName[] array.
280*/
281static const PragmaName *pragmaLocate(const char *zName){
mistachkin2e525322017-02-01 22:43:08 +0000282 int upr, lwr, mid = 0, rc;
drh2fcc1592016-12-15 20:59:03 +0000283 lwr = 0;
284 upr = ArraySize(aPragmaName)-1;
285 while( lwr<=upr ){
286 mid = (lwr+upr)/2;
287 rc = sqlite3_stricmp(zName, aPragmaName[mid].zName);
288 if( rc==0 ) break;
289 if( rc<0 ){
290 upr = mid - 1;
291 }else{
292 lwr = mid + 1;
293 }
294 }
295 return lwr>upr ? 0 : &aPragmaName[mid];
296}
297
298/*
drh79d5bc82020-01-04 01:43:02 +0000299** Create zero or more entries in the output for the SQL functions
300** defined by FuncDef p.
301*/
drh337ca512020-01-04 19:58:28 +0000302static void pragmaFunclistLine(
303 Vdbe *v, /* The prepared statement being created */
304 FuncDef *p, /* A particular function definition */
305 int isBuiltin, /* True if this is a built-in function */
306 int showInternFuncs /* True if showing internal functions */
307){
drh79d5bc82020-01-04 01:43:02 +0000308 for(; p; p=p->pNext){
309 const char *zType;
drh79d5bc82020-01-04 01:43:02 +0000310 static const u32 mask =
311 SQLITE_DETERMINISTIC |
312 SQLITE_DIRECTONLY |
313 SQLITE_SUBTYPE |
drh337ca512020-01-04 19:58:28 +0000314 SQLITE_INNOCUOUS |
315 SQLITE_FUNC_INTERNAL
drh79d5bc82020-01-04 01:43:02 +0000316 ;
drhb84fda32020-01-09 16:28:50 +0000317 static const char *azEnc[] = { 0, "utf8", "utf16le", "utf16be" };
318
319 assert( SQLITE_FUNC_ENCMASK==0x3 );
320 assert( strcmp(azEnc[SQLITE_UTF8],"utf8")==0 );
321 assert( strcmp(azEnc[SQLITE_UTF16LE],"utf16le")==0 );
322 assert( strcmp(azEnc[SQLITE_UTF16BE],"utf16be")==0 );
drh337ca512020-01-04 19:58:28 +0000323
drh79d5bc82020-01-04 01:43:02 +0000324 if( p->xSFunc==0 ) continue;
drh337ca512020-01-04 19:58:28 +0000325 if( (p->funcFlags & SQLITE_FUNC_INTERNAL)!=0
326 && showInternFuncs==0
327 ){
328 continue;
329 }
drh79d5bc82020-01-04 01:43:02 +0000330 if( p->xValue!=0 ){
331 zType = "w";
332 }else if( p->xFinalize!=0 ){
333 zType = "a";
334 }else{
335 zType = "s";
336 }
drh79d5bc82020-01-04 01:43:02 +0000337 sqlite3VdbeMultiLoad(v, 1, "sissii",
338 p->zName, isBuiltin,
drhb84fda32020-01-09 16:28:50 +0000339 zType, azEnc[p->funcFlags&SQLITE_FUNC_ENCMASK],
drh79d5bc82020-01-04 01:43:02 +0000340 p->nArg,
341 (p->funcFlags & mask) ^ SQLITE_INNOCUOUS
342 );
343 }
344}
345
346
347/*
drh66accfc2017-02-22 18:04:42 +0000348** Helper subroutine for PRAGMA integrity_check:
349**
drh9ecd7082017-09-10 01:06:05 +0000350** Generate code to output a single-column result row with a value of the
351** string held in register 3. Decrement the result count in register 1
352** and halt if the maximum number of result rows have been issued.
drh66accfc2017-02-22 18:04:42 +0000353*/
drh9ecd7082017-09-10 01:06:05 +0000354static int integrityCheckResultRow(Vdbe *v){
drh66accfc2017-02-22 18:04:42 +0000355 int addr;
drh9ecd7082017-09-10 01:06:05 +0000356 sqlite3VdbeAddOp2(v, OP_ResultRow, 3, 1);
drh66accfc2017-02-22 18:04:42 +0000357 addr = sqlite3VdbeAddOp3(v, OP_IfPos, 1, sqlite3VdbeCurrentAddr(v)+2, 1);
358 VdbeCoverage(v);
drh9ecd7082017-09-10 01:06:05 +0000359 sqlite3VdbeAddOp0(v, OP_Halt);
drh66accfc2017-02-22 18:04:42 +0000360 return addr;
361}
362
363/*
drhc11d4f92003-04-06 21:08:24 +0000364** Process a pragma statement.
365**
366** Pragmas are of this form:
367**
drh9b0cf342015-11-12 14:57:19 +0000368** PRAGMA [schema.]id [= value]
drhc11d4f92003-04-06 21:08:24 +0000369**
370** The identifier might also be a string. The value is a string, and
371** identifier, or a number. If minusFlag is true, then the value is
372** a number that was preceded by a minus sign.
drh90f5ecb2004-07-22 01:19:35 +0000373**
374** If the left side is "database.id" then pId1 is the database name
375** and pId2 is the id. If the left side is just "id" then pId1 is the
376** id and pId2 is any empty string.
drhc11d4f92003-04-06 21:08:24 +0000377*/
danielk197791cf71b2004-06-26 06:37:06 +0000378void sqlite3Pragma(
379 Parse *pParse,
drh9b0cf342015-11-12 14:57:19 +0000380 Token *pId1, /* First part of [schema.]id field */
381 Token *pId2, /* Second part of [schema.]id field, or NULL */
danielk197791cf71b2004-06-26 06:37:06 +0000382 Token *pValue, /* Token for <value>, or NULL */
383 int minusFlag /* True if a '-' sign preceded <value> */
384){
385 char *zLeft = 0; /* Nul-terminated UTF-8 string <id> */
386 char *zRight = 0; /* Nul-terminated UTF-8 string <value>, or NULL */
387 const char *zDb = 0; /* The database name */
388 Token *pId; /* Pointer to <id> token */
drh3fa97302012-02-22 16:58:36 +0000389 char *aFcntl[4]; /* Argument to SQLITE_FCNTL_PRAGMA */
drh9ccd8652013-09-13 16:36:46 +0000390 int iDb; /* Database index for <database> */
drh06fd5d62012-02-22 14:45:19 +0000391 int rc; /* return value form SQLITE_FCNTL_PRAGMA */
392 sqlite3 *db = pParse->db; /* The database connection */
393 Db *pDb; /* The specific database being pragmaed */
drhef8e9862013-04-11 13:26:18 +0000394 Vdbe *v = sqlite3GetVdbe(pParse); /* Prepared statement */
drh2fcc1592016-12-15 20:59:03 +0000395 const PragmaName *pPragma; /* The pragma */
drh06fd5d62012-02-22 14:45:19 +0000396
drhc11d4f92003-04-06 21:08:24 +0000397 if( v==0 ) return;
drh4611d922010-02-25 14:47:01 +0000398 sqlite3VdbeRunOnlyOnce(v);
drh9cbf3422008-01-17 16:22:13 +0000399 pParse->nMem = 2;
drhc11d4f92003-04-06 21:08:24 +0000400
drh9b0cf342015-11-12 14:57:19 +0000401 /* Interpret the [schema.] part of the pragma statement. iDb is the
danielk197791cf71b2004-06-26 06:37:06 +0000402 ** index of the database this pragma is being applied to in db.aDb[]. */
403 iDb = sqlite3TwoPartName(pParse, pId1, pId2, &pId);
404 if( iDb<0 ) return;
drh90f5ecb2004-07-22 01:19:35 +0000405 pDb = &db->aDb[iDb];
danielk197791cf71b2004-06-26 06:37:06 +0000406
danielk1977ddfb2f02006-02-17 12:25:14 +0000407 /* If the temp database has been explicitly named as part of the
408 ** pragma, make sure it is open.
409 */
410 if( iDb==1 && sqlite3OpenTempDatabase(pParse) ){
411 return;
412 }
413
drh17435752007-08-16 04:30:38 +0000414 zLeft = sqlite3NameFromToken(db, pId);
danielk197796fb0dd2004-06-30 09:49:22 +0000415 if( !zLeft ) return;
drhc11d4f92003-04-06 21:08:24 +0000416 if( minusFlag ){
drh17435752007-08-16 04:30:38 +0000417 zRight = sqlite3MPrintf(db, "-%T", pValue);
drhc11d4f92003-04-06 21:08:24 +0000418 }else{
drh17435752007-08-16 04:30:38 +0000419 zRight = sqlite3NameFromToken(db, pValue);
drhc11d4f92003-04-06 21:08:24 +0000420 }
danielk197791cf71b2004-06-26 06:37:06 +0000421
drhd2cb50b2009-01-09 21:41:17 +0000422 assert( pId2 );
drh69c33822016-08-18 14:33:11 +0000423 zDb = pId2->n>0 ? pDb->zDbSName : 0;
danielk197791cf71b2004-06-26 06:37:06 +0000424 if( sqlite3AuthCheck(pParse, SQLITE_PRAGMA, zLeft, zRight, zDb) ){
danielk1977e0048402004-06-15 16:51:01 +0000425 goto pragma_out;
drhc11d4f92003-04-06 21:08:24 +0000426 }
drh06fd5d62012-02-22 14:45:19 +0000427
428 /* Send an SQLITE_FCNTL_PRAGMA file-control to the underlying VFS
429 ** connection. If it returns SQLITE_OK, then assume that the VFS
430 ** handled the pragma and generate a no-op prepared statement.
drh8dd7a6a2015-03-06 04:37:26 +0000431 **
432 ** IMPLEMENTATION-OF: R-12238-55120 Whenever a PRAGMA statement is parsed,
433 ** an SQLITE_FCNTL_PRAGMA file control is sent to the open sqlite3_file
434 ** object corresponding to the database file to which the pragma
435 ** statement refers.
436 **
437 ** IMPLEMENTATION-OF: R-29875-31678 The argument to the SQLITE_FCNTL_PRAGMA
438 ** file control is an array of pointers to strings (char**) in which the
439 ** second element of the array is the name of the pragma and the third
440 ** element is the argument to the pragma or NULL if the pragma has no
441 ** argument.
drh06fd5d62012-02-22 14:45:19 +0000442 */
drh3fa97302012-02-22 16:58:36 +0000443 aFcntl[0] = 0;
444 aFcntl[1] = zLeft;
445 aFcntl[2] = zRight;
446 aFcntl[3] = 0;
dan80bb6f82012-10-01 18:44:33 +0000447 db->busyHandler.nBusy = 0;
drh06fd5d62012-02-22 14:45:19 +0000448 rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_PRAGMA, (void*)aFcntl);
449 if( rc==SQLITE_OK ){
drhc232aca2016-12-15 16:01:17 +0000450 sqlite3VdbeSetNumCols(v, 1);
451 sqlite3VdbeSetColName(v, 0, COLNAME_NAME, aFcntl[0], SQLITE_TRANSIENT);
452 returnSingleText(v, aFcntl[0]);
drh7cc023c2015-09-03 04:28:25 +0000453 sqlite3_free(aFcntl[0]);
drh9ccd8652013-09-13 16:36:46 +0000454 goto pragma_out;
455 }
456 if( rc!=SQLITE_NOTFOUND ){
drh92c700d2012-02-22 19:56:17 +0000457 if( aFcntl[0] ){
458 sqlite3ErrorMsg(pParse, "%s", aFcntl[0]);
459 sqlite3_free(aFcntl[0]);
460 }
461 pParse->nErr++;
462 pParse->rc = rc;
drh9ccd8652013-09-13 16:36:46 +0000463 goto pragma_out;
464 }
465
466 /* Locate the pragma in the lookup table */
drh2fcc1592016-12-15 20:59:03 +0000467 pPragma = pragmaLocate(zLeft);
468 if( pPragma==0 ) goto pragma_out;
drh9ccd8652013-09-13 16:36:46 +0000469
drhf63936e2013-10-03 14:08:07 +0000470 /* Make sure the database schema is loaded if the pragma requires that */
drhc232aca2016-12-15 16:01:17 +0000471 if( (pPragma->mPragFlg & PragFlg_NeedSchema)!=0 ){
drhf63936e2013-10-03 14:08:07 +0000472 if( sqlite3ReadSchema(pParse) ) goto pragma_out;
473 }
474
drhc232aca2016-12-15 16:01:17 +0000475 /* Register the result column names for pragmas that return results */
dan9e1ab1a2017-01-05 19:32:48 +0000476 if( (pPragma->mPragFlg & PragFlg_NoColumns)==0
477 && ((pPragma->mPragFlg & PragFlg_NoColumns1)==0 || zRight==0)
478 ){
drhc232aca2016-12-15 16:01:17 +0000479 setPragmaResultColumnNames(v, pPragma);
480 }
481
drh9ccd8652013-09-13 16:36:46 +0000482 /* Jump to the appropriate pragma handler */
drhc228be52015-01-31 02:00:01 +0000483 switch( pPragma->ePragTyp ){
drh9ccd8652013-09-13 16:36:46 +0000484
drhe73c9142011-11-09 16:12:24 +0000485#if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
drhc11d4f92003-04-06 21:08:24 +0000486 /*
drh9b0cf342015-11-12 14:57:19 +0000487 ** PRAGMA [schema.]default_cache_size
488 ** PRAGMA [schema.]default_cache_size=N
drhc11d4f92003-04-06 21:08:24 +0000489 **
490 ** The first form reports the current persistent setting for the
491 ** page cache size. The value returned is the maximum number of
492 ** pages in the page cache. The second form sets both the current
493 ** page cache size value and the persistent page cache size value
494 ** stored in the database file.
495 **
drh93791ea2010-04-26 17:36:35 +0000496 ** Older versions of SQLite would set the default cache size to a
497 ** negative number to indicate synchronous=OFF. These days, synchronous
498 ** is always on by default regardless of the sign of the default cache
499 ** size. But continue to take the absolute value of the default cache
500 ** size of historical compatibility.
drhc11d4f92003-04-06 21:08:24 +0000501 */
drh9ccd8652013-09-13 16:36:46 +0000502 case PragTyp_DEFAULT_CACHE_SIZE: {
drhb06a4ec2014-03-10 18:03:09 +0000503 static const int iLn = VDBE_OFFSET_LINENO(2);
drh57196282004-10-06 15:41:16 +0000504 static const VdbeOpList getCacheSize[] = {
danielk1977602b4662009-07-02 07:47:33 +0000505 { OP_Transaction, 0, 0, 0}, /* 0 */
506 { OP_ReadCookie, 0, 1, BTREE_DEFAULT_CACHE_SIZE}, /* 1 */
drhef8e9862013-04-11 13:26:18 +0000507 { OP_IfPos, 1, 8, 0},
drh3c84ddf2008-01-09 02:15:38 +0000508 { OP_Integer, 0, 2, 0},
509 { OP_Subtract, 1, 2, 1},
drhef8e9862013-04-11 13:26:18 +0000510 { OP_IfPos, 1, 8, 0},
danielk1977602b4662009-07-02 07:47:33 +0000511 { OP_Integer, 0, 1, 0}, /* 6 */
drhef8e9862013-04-11 13:26:18 +0000512 { OP_Noop, 0, 0, 0},
drh3c84ddf2008-01-09 02:15:38 +0000513 { OP_ResultRow, 1, 1, 0},
drhc11d4f92003-04-06 21:08:24 +0000514 };
drh2ce18652016-01-16 20:50:21 +0000515 VdbeOp *aOp;
drhfb982642007-08-30 01:19:59 +0000516 sqlite3VdbeUsesBtree(v, iDb);
danielk197791cf71b2004-06-26 06:37:06 +0000517 if( !zRight ){
drh3c84ddf2008-01-09 02:15:38 +0000518 pParse->nMem += 2;
drhdad300d2016-01-18 00:20:26 +0000519 sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(getCacheSize));
drh2ce18652016-01-16 20:50:21 +0000520 aOp = sqlite3VdbeAddOpList(v, ArraySize(getCacheSize), getCacheSize, iLn);
drhdad300d2016-01-18 00:20:26 +0000521 if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
drh2ce18652016-01-16 20:50:21 +0000522 aOp[0].p1 = iDb;
523 aOp[1].p1 = iDb;
524 aOp[6].p1 = SQLITE_DEFAULT_CACHE_SIZE;
drhc11d4f92003-04-06 21:08:24 +0000525 }else{
drhd50ffc42011-03-08 02:38:28 +0000526 int size = sqlite3AbsInt32(sqlite3Atoi(zRight));
danielk197791cf71b2004-06-26 06:37:06 +0000527 sqlite3BeginWriteOperation(pParse, 0, iDb);
drh1861afc2016-02-01 21:48:34 +0000528 sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_DEFAULT_CACHE_SIZE, size);
drh21206082011-04-04 18:22:02 +0000529 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk197714db2662006-01-09 16:12:04 +0000530 pDb->pSchema->cache_size = size;
531 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
drhc11d4f92003-04-06 21:08:24 +0000532 }
drh9ccd8652013-09-13 16:36:46 +0000533 break;
534 }
drhe73c9142011-11-09 16:12:24 +0000535#endif /* !SQLITE_OMIT_PAGER_PRAGMAS && !SQLITE_OMIT_DEPRECATED */
drhc11d4f92003-04-06 21:08:24 +0000536
drhe73c9142011-11-09 16:12:24 +0000537#if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
drhc11d4f92003-04-06 21:08:24 +0000538 /*
drh9b0cf342015-11-12 14:57:19 +0000539 ** PRAGMA [schema.]page_size
540 ** PRAGMA [schema.]page_size=N
drh90f5ecb2004-07-22 01:19:35 +0000541 **
542 ** The first form reports the current setting for the
543 ** database page size in bytes. The second form sets the
544 ** database page size value. The value can only be set if
545 ** the database has not yet been created.
546 */
drh9ccd8652013-09-13 16:36:46 +0000547 case PragTyp_PAGE_SIZE: {
drh90f5ecb2004-07-22 01:19:35 +0000548 Btree *pBt = pDb->pBt;
drhd2cb50b2009-01-09 21:41:17 +0000549 assert( pBt!=0 );
drh90f5ecb2004-07-22 01:19:35 +0000550 if( !zRight ){
drhd2cb50b2009-01-09 21:41:17 +0000551 int size = ALWAYS(pBt) ? sqlite3BtreeGetPageSize(pBt) : 0;
drhc232aca2016-12-15 16:01:17 +0000552 returnSingleInt(v, size);
drh90f5ecb2004-07-22 01:19:35 +0000553 }else{
danielk1977992772c2007-08-30 10:07:38 +0000554 /* Malloc may fail when setting the page-size, as there is an internal
555 ** buffer that the pager module resizes using sqlite3_realloc().
556 */
drh60ac3f42010-11-23 18:59:27 +0000557 db->nextPagesize = sqlite3Atoi(zRight);
drhe73c9142011-11-09 16:12:24 +0000558 if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize,-1,0) ){
drh4a642b62016-02-05 01:55:27 +0000559 sqlite3OomFault(db);
danielk1977992772c2007-08-30 10:07:38 +0000560 }
drh90f5ecb2004-07-22 01:19:35 +0000561 }
drh9ccd8652013-09-13 16:36:46 +0000562 break;
563 }
danielk197741483462007-03-24 16:45:04 +0000564
565 /*
drh9b0cf342015-11-12 14:57:19 +0000566 ** PRAGMA [schema.]secure_delete
drha5907a82017-06-19 11:44:22 +0000567 ** PRAGMA [schema.]secure_delete=ON/OFF/FAST
drh5b47efa2010-02-12 18:18:39 +0000568 **
569 ** The first form reports the current setting for the
570 ** secure_delete flag. The second form changes the secure_delete
drha5907a82017-06-19 11:44:22 +0000571 ** flag setting and reports the new value.
drh5b47efa2010-02-12 18:18:39 +0000572 */
drh9ccd8652013-09-13 16:36:46 +0000573 case PragTyp_SECURE_DELETE: {
drh5b47efa2010-02-12 18:18:39 +0000574 Btree *pBt = pDb->pBt;
575 int b = -1;
576 assert( pBt!=0 );
577 if( zRight ){
drha5907a82017-06-19 11:44:22 +0000578 if( sqlite3_stricmp(zRight, "fast")==0 ){
579 b = 2;
580 }else{
581 b = sqlite3GetBoolean(zRight, 0);
582 }
drh5b47efa2010-02-12 18:18:39 +0000583 }
drhaf034ed2010-02-12 19:46:26 +0000584 if( pId2->n==0 && b>=0 ){
585 int ii;
586 for(ii=0; ii<db->nDb; ii++){
587 sqlite3BtreeSecureDelete(db->aDb[ii].pBt, b);
588 }
589 }
drh5b47efa2010-02-12 18:18:39 +0000590 b = sqlite3BtreeSecureDelete(pBt, b);
drhc232aca2016-12-15 16:01:17 +0000591 returnSingleInt(v, b);
drh9ccd8652013-09-13 16:36:46 +0000592 break;
593 }
drh5b47efa2010-02-12 18:18:39 +0000594
595 /*
drh9b0cf342015-11-12 14:57:19 +0000596 ** PRAGMA [schema.]max_page_count
597 ** PRAGMA [schema.]max_page_count=N
drh60ac3f42010-11-23 18:59:27 +0000598 **
599 ** The first form reports the current setting for the
600 ** maximum number of pages in the database file. The
601 ** second form attempts to change this setting. Both
602 ** forms return the current setting.
603 **
drhe73c9142011-11-09 16:12:24 +0000604 ** The absolute value of N is used. This is undocumented and might
605 ** change. The only purpose is to provide an easy way to test
606 ** the sqlite3AbsInt32() function.
607 **
drh9b0cf342015-11-12 14:57:19 +0000608 ** PRAGMA [schema.]page_count
danielk197759a93792008-05-15 17:48:20 +0000609 **
610 ** Return the number of pages in the specified database.
611 */
drh9ccd8652013-09-13 16:36:46 +0000612 case PragTyp_PAGE_COUNT: {
danielk197759a93792008-05-15 17:48:20 +0000613 int iReg;
danielk197759a93792008-05-15 17:48:20 +0000614 sqlite3CodeVerifySchema(pParse, iDb);
615 iReg = ++pParse->nMem;
drhc5227312011-10-13 17:09:01 +0000616 if( sqlite3Tolower(zLeft[0])=='p' ){
drh60ac3f42010-11-23 18:59:27 +0000617 sqlite3VdbeAddOp2(v, OP_Pagecount, iDb, iReg);
618 }else{
drhe73c9142011-11-09 16:12:24 +0000619 sqlite3VdbeAddOp3(v, OP_MaxPgcnt, iDb, iReg,
620 sqlite3AbsInt32(sqlite3Atoi(zRight)));
drh60ac3f42010-11-23 18:59:27 +0000621 }
danielk197759a93792008-05-15 17:48:20 +0000622 sqlite3VdbeAddOp2(v, OP_ResultRow, iReg, 1);
drh9ccd8652013-09-13 16:36:46 +0000623 break;
624 }
danielk197759a93792008-05-15 17:48:20 +0000625
626 /*
drh9b0cf342015-11-12 14:57:19 +0000627 ** PRAGMA [schema.]locking_mode
628 ** PRAGMA [schema.]locking_mode = (normal|exclusive)
danielk197741483462007-03-24 16:45:04 +0000629 */
drh9ccd8652013-09-13 16:36:46 +0000630 case PragTyp_LOCKING_MODE: {
danielk197741483462007-03-24 16:45:04 +0000631 const char *zRet = "normal";
632 int eMode = getLockingMode(zRight);
633
634 if( pId2->n==0 && eMode==PAGER_LOCKINGMODE_QUERY ){
635 /* Simple "PRAGMA locking_mode;" statement. This is a query for
636 ** the current default locking mode (which may be different to
637 ** the locking-mode of the main database).
638 */
639 eMode = db->dfltLockMode;
640 }else{
641 Pager *pPager;
642 if( pId2->n==0 ){
643 /* This indicates that no database name was specified as part
644 ** of the PRAGMA command. In this case the locking-mode must be
645 ** set on all attached databases, as well as the main db file.
646 **
647 ** Also, the sqlite3.dfltLockMode variable is set so that
648 ** any subsequently attached databases also use the specified
649 ** locking mode.
650 */
651 int ii;
652 assert(pDb==&db->aDb[0]);
653 for(ii=2; ii<db->nDb; ii++){
654 pPager = sqlite3BtreePager(db->aDb[ii].pBt);
655 sqlite3PagerLockingMode(pPager, eMode);
656 }
drh4f21c4a2008-12-10 22:15:00 +0000657 db->dfltLockMode = (u8)eMode;
danielk197741483462007-03-24 16:45:04 +0000658 }
659 pPager = sqlite3BtreePager(pDb->pBt);
660 eMode = sqlite3PagerLockingMode(pPager, eMode);
661 }
662
drh9ccd8652013-09-13 16:36:46 +0000663 assert( eMode==PAGER_LOCKINGMODE_NORMAL
664 || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
danielk197741483462007-03-24 16:45:04 +0000665 if( eMode==PAGER_LOCKINGMODE_EXCLUSIVE ){
666 zRet = "exclusive";
667 }
drhc232aca2016-12-15 16:01:17 +0000668 returnSingleText(v, zRet);
drh9ccd8652013-09-13 16:36:46 +0000669 break;
670 }
drh3b020132008-04-17 17:02:01 +0000671
672 /*
drh9b0cf342015-11-12 14:57:19 +0000673 ** PRAGMA [schema.]journal_mode
674 ** PRAGMA [schema.]journal_mode =
drh3ebaee92010-05-06 21:37:22 +0000675 ** (delete|persist|off|truncate|memory|wal|off)
drh3b020132008-04-17 17:02:01 +0000676 */
drh9ccd8652013-09-13 16:36:46 +0000677 case PragTyp_JOURNAL_MODE: {
drhc6b2a0f2010-07-08 17:40:37 +0000678 int eMode; /* One of the PAGER_JOURNALMODE_XXX symbols */
679 int ii; /* Loop counter */
dane04dc882010-04-20 18:53:15 +0000680
drh3b020132008-04-17 17:02:01 +0000681 if( zRight==0 ){
drhc6b2a0f2010-07-08 17:40:37 +0000682 /* If there is no "=MODE" part of the pragma, do a query for the
683 ** current mode */
drh3b020132008-04-17 17:02:01 +0000684 eMode = PAGER_JOURNALMODE_QUERY;
685 }else{
dane04dc882010-04-20 18:53:15 +0000686 const char *zMode;
drhea678832008-12-10 19:26:22 +0000687 int n = sqlite3Strlen30(zRight);
drhf77e2ac2010-07-07 14:33:09 +0000688 for(eMode=0; (zMode = sqlite3JournalModename(eMode))!=0; eMode++){
dane04dc882010-04-20 18:53:15 +0000689 if( sqlite3StrNICmp(zRight, zMode, n)==0 ) break;
690 }
691 if( !zMode ){
drhc6b2a0f2010-07-08 17:40:37 +0000692 /* If the "=MODE" part does not match any known journal mode,
693 ** then do a query */
dane04dc882010-04-20 18:53:15 +0000694 eMode = PAGER_JOURNALMODE_QUERY;
drh3b020132008-04-17 17:02:01 +0000695 }
drh6c35b302019-05-17 20:37:17 +0000696 if( eMode==PAGER_JOURNALMODE_OFF && (db->flags & SQLITE_Defensive)!=0 ){
697 /* Do not allow journal-mode "OFF" in defensive since the database
698 ** can become corrupted using ordinary SQL when the journal is off */
699 eMode = PAGER_JOURNALMODE_QUERY;
700 }
drh3b020132008-04-17 17:02:01 +0000701 }
drhc6b2a0f2010-07-08 17:40:37 +0000702 if( eMode==PAGER_JOURNALMODE_QUERY && pId2->n==0 ){
703 /* Convert "PRAGMA journal_mode" into "PRAGMA main.journal_mode" */
704 iDb = 0;
705 pId2->n = 1;
706 }
707 for(ii=db->nDb-1; ii>=0; ii--){
708 if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
709 sqlite3VdbeUsesBtree(v, ii);
710 sqlite3VdbeAddOp3(v, OP_JournalMode, ii, 1, eMode);
dane04dc882010-04-20 18:53:15 +0000711 }
drh3b020132008-04-17 17:02:01 +0000712 }
drh3b020132008-04-17 17:02:01 +0000713 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
drh9ccd8652013-09-13 16:36:46 +0000714 break;
715 }
danielk1977b53e4962008-06-04 06:45:59 +0000716
717 /*
drh9b0cf342015-11-12 14:57:19 +0000718 ** PRAGMA [schema.]journal_size_limit
719 ** PRAGMA [schema.]journal_size_limit=N
danielk1977b53e4962008-06-04 06:45:59 +0000720 **
drha9e364f2009-01-13 20:14:15 +0000721 ** Get or set the size limit on rollback journal files.
danielk1977b53e4962008-06-04 06:45:59 +0000722 */
drh9ccd8652013-09-13 16:36:46 +0000723 case PragTyp_JOURNAL_SIZE_LIMIT: {
danielk1977b53e4962008-06-04 06:45:59 +0000724 Pager *pPager = sqlite3BtreePager(pDb->pBt);
725 i64 iLimit = -2;
726 if( zRight ){
drh9296c182014-07-23 13:40:49 +0000727 sqlite3DecOrHexToI64(zRight, &iLimit);
drh3c713642009-04-04 16:02:32 +0000728 if( iLimit<-1 ) iLimit = -1;
danielk1977b53e4962008-06-04 06:45:59 +0000729 }
730 iLimit = sqlite3PagerJournalSizeLimit(pPager, iLimit);
drhc232aca2016-12-15 16:01:17 +0000731 returnSingleInt(v, iLimit);
drh9ccd8652013-09-13 16:36:46 +0000732 break;
733 }
danielk1977b53e4962008-06-04 06:45:59 +0000734
drh13d70422004-11-13 15:59:14 +0000735#endif /* SQLITE_OMIT_PAGER_PRAGMAS */
drh90f5ecb2004-07-22 01:19:35 +0000736
737 /*
drh9b0cf342015-11-12 14:57:19 +0000738 ** PRAGMA [schema.]auto_vacuum
739 ** PRAGMA [schema.]auto_vacuum=N
danielk1977951af802004-11-05 15:45:09 +0000740 **
drha9e364f2009-01-13 20:14:15 +0000741 ** Get or set the value of the database 'auto-vacuum' parameter.
742 ** The value is one of: 0 NONE 1 FULL 2 INCREMENTAL
danielk1977951af802004-11-05 15:45:09 +0000743 */
744#ifndef SQLITE_OMIT_AUTOVACUUM
drh9ccd8652013-09-13 16:36:46 +0000745 case PragTyp_AUTO_VACUUM: {
danielk1977951af802004-11-05 15:45:09 +0000746 Btree *pBt = pDb->pBt;
drhd2cb50b2009-01-09 21:41:17 +0000747 assert( pBt!=0 );
danielk1977951af802004-11-05 15:45:09 +0000748 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +0000749 returnSingleInt(v, sqlite3BtreeGetAutoVacuum(pBt));
danielk1977951af802004-11-05 15:45:09 +0000750 }else{
danielk1977dddbcdc2007-04-26 14:42:34 +0000751 int eAuto = getAutoVacuum(zRight);
drhd2cb50b2009-01-09 21:41:17 +0000752 assert( eAuto>=0 && eAuto<=2 );
drh4f21c4a2008-12-10 22:15:00 +0000753 db->nextAutovac = (u8)eAuto;
drhf63936e2013-10-03 14:08:07 +0000754 /* Call SetAutoVacuum() to set initialize the internal auto and
755 ** incr-vacuum flags. This is required in case this connection
756 ** creates the database file. It is important that it is created
757 ** as an auto-vacuum capable db.
758 */
759 rc = sqlite3BtreeSetAutoVacuum(pBt, eAuto);
760 if( rc==SQLITE_OK && (eAuto==1 || eAuto==2) ){
761 /* When setting the auto_vacuum mode to either "full" or
762 ** "incremental", write the value of meta[6] in the database
763 ** file. Before writing to meta[6], check that meta[3] indicates
764 ** that this really is an auto-vacuum capable database.
danielk197727b1f952007-06-25 08:16:58 +0000765 */
drhb06a4ec2014-03-10 18:03:09 +0000766 static const int iLn = VDBE_OFFSET_LINENO(2);
drhf63936e2013-10-03 14:08:07 +0000767 static const VdbeOpList setMeta6[] = {
768 { OP_Transaction, 0, 1, 0}, /* 0 */
769 { OP_ReadCookie, 0, 1, BTREE_LARGEST_ROOT_PAGE},
770 { OP_If, 1, 0, 0}, /* 2 */
771 { OP_Halt, SQLITE_OK, OE_Abort, 0}, /* 3 */
drh1861afc2016-02-01 21:48:34 +0000772 { OP_SetCookie, 0, BTREE_INCR_VACUUM, 0}, /* 4 */
drhf63936e2013-10-03 14:08:07 +0000773 };
drh2ce18652016-01-16 20:50:21 +0000774 VdbeOp *aOp;
775 int iAddr = sqlite3VdbeCurrentAddr(v);
drhdad300d2016-01-18 00:20:26 +0000776 sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setMeta6));
drh2ce18652016-01-16 20:50:21 +0000777 aOp = sqlite3VdbeAddOpList(v, ArraySize(setMeta6), setMeta6, iLn);
drhdad300d2016-01-18 00:20:26 +0000778 if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
drh2ce18652016-01-16 20:50:21 +0000779 aOp[0].p1 = iDb;
780 aOp[1].p1 = iDb;
781 aOp[2].p2 = iAddr+4;
drh1861afc2016-02-01 21:48:34 +0000782 aOp[4].p1 = iDb;
783 aOp[4].p3 = eAuto - 1;
drhf63936e2013-10-03 14:08:07 +0000784 sqlite3VdbeUsesBtree(v, iDb);
danielk1977dddbcdc2007-04-26 14:42:34 +0000785 }
danielk1977951af802004-11-05 15:45:09 +0000786 }
drh9ccd8652013-09-13 16:36:46 +0000787 break;
788 }
danielk1977951af802004-11-05 15:45:09 +0000789#endif
790
drhca5557f2007-05-04 18:30:40 +0000791 /*
drh9b0cf342015-11-12 14:57:19 +0000792 ** PRAGMA [schema.]incremental_vacuum(N)
drhca5557f2007-05-04 18:30:40 +0000793 **
794 ** Do N steps of incremental vacuuming on a database.
795 */
796#ifndef SQLITE_OMIT_AUTOVACUUM
drh9ccd8652013-09-13 16:36:46 +0000797 case PragTyp_INCREMENTAL_VACUUM: {
drhca5557f2007-05-04 18:30:40 +0000798 int iLimit, addr;
799 if( zRight==0 || !sqlite3GetInt32(zRight, &iLimit) || iLimit<=0 ){
800 iLimit = 0x7fffffff;
801 }
802 sqlite3BeginWriteOperation(pParse, 0, iDb);
drh4c583122008-01-04 22:01:03 +0000803 sqlite3VdbeAddOp2(v, OP_Integer, iLimit, 1);
drh688852a2014-02-17 22:40:43 +0000804 addr = sqlite3VdbeAddOp1(v, OP_IncrVacuum, iDb); VdbeCoverage(v);
drh2d401ab2008-01-10 23:50:11 +0000805 sqlite3VdbeAddOp1(v, OP_ResultRow, 1);
drh8558cde2008-01-05 05:20:10 +0000806 sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1);
drh688852a2014-02-17 22:40:43 +0000807 sqlite3VdbeAddOp2(v, OP_IfPos, 1, addr); VdbeCoverage(v);
drhca5557f2007-05-04 18:30:40 +0000808 sqlite3VdbeJumpHere(v, addr);
drh9ccd8652013-09-13 16:36:46 +0000809 break;
810 }
drhca5557f2007-05-04 18:30:40 +0000811#endif
812
drh13d70422004-11-13 15:59:14 +0000813#ifndef SQLITE_OMIT_PAGER_PRAGMAS
danielk1977951af802004-11-05 15:45:09 +0000814 /*
drh9b0cf342015-11-12 14:57:19 +0000815 ** PRAGMA [schema.]cache_size
816 ** PRAGMA [schema.]cache_size=N
drhc11d4f92003-04-06 21:08:24 +0000817 **
818 ** The first form reports the current local setting for the
drh3b42abb2011-11-09 14:23:04 +0000819 ** page cache size. The second form sets the local
820 ** page cache size value. If N is positive then that is the
821 ** number of pages in the cache. If N is negative, then the
822 ** number of pages is adjusted so that the cache uses -N kibibytes
823 ** of memory.
drhc11d4f92003-04-06 21:08:24 +0000824 */
drh9ccd8652013-09-13 16:36:46 +0000825 case PragTyp_CACHE_SIZE: {
drh21206082011-04-04 18:22:02 +0000826 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
danielk197791cf71b2004-06-26 06:37:06 +0000827 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +0000828 returnSingleInt(v, pDb->pSchema->cache_size);
drhc11d4f92003-04-06 21:08:24 +0000829 }else{
drh3b42abb2011-11-09 14:23:04 +0000830 int size = sqlite3Atoi(zRight);
danielk197714db2662006-01-09 16:12:04 +0000831 pDb->pSchema->cache_size = size;
832 sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
drhc11d4f92003-04-06 21:08:24 +0000833 }
drh9ccd8652013-09-13 16:36:46 +0000834 break;
835 }
drhc11d4f92003-04-06 21:08:24 +0000836
837 /*
drh9b0cf342015-11-12 14:57:19 +0000838 ** PRAGMA [schema.]cache_spill
839 ** PRAGMA cache_spill=BOOLEAN
840 ** PRAGMA [schema.]cache_spill=N
841 **
842 ** The first form reports the current local setting for the
843 ** page cache spill size. The second form turns cache spill on
844 ** or off. When turnning cache spill on, the size is set to the
845 ** current cache_size. The third form sets a spill size that
846 ** may be different form the cache size.
847 ** If N is positive then that is the
848 ** number of pages in the cache. If N is negative, then the
849 ** number of pages is adjusted so that the cache uses -N kibibytes
850 ** of memory.
851 **
852 ** If the number of cache_spill pages is less then the number of
853 ** cache_size pages, no spilling occurs until the page count exceeds
854 ** the number of cache_size pages.
855 **
856 ** The cache_spill=BOOLEAN setting applies to all attached schemas,
857 ** not just the schema specified.
858 */
859 case PragTyp_CACHE_SPILL: {
drh9b0cf342015-11-12 14:57:19 +0000860 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
861 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +0000862 returnSingleInt(v,
drh9b0cf342015-11-12 14:57:19 +0000863 (db->flags & SQLITE_CacheSpill)==0 ? 0 :
864 sqlite3BtreeSetSpillSize(pDb->pBt,0));
865 }else{
drh4f9c8ec2015-11-12 15:47:48 +0000866 int size = 1;
drh9b0cf342015-11-12 14:57:19 +0000867 if( sqlite3GetInt32(zRight, &size) ){
868 sqlite3BtreeSetSpillSize(pDb->pBt, size);
869 }
drh4f9c8ec2015-11-12 15:47:48 +0000870 if( sqlite3GetBoolean(zRight, size!=0) ){
drh9b0cf342015-11-12 14:57:19 +0000871 db->flags |= SQLITE_CacheSpill;
872 }else{
drhd5b44d62018-12-06 17:06:02 +0000873 db->flags &= ~(u64)SQLITE_CacheSpill;
drh9b0cf342015-11-12 14:57:19 +0000874 }
drh4f9c8ec2015-11-12 15:47:48 +0000875 setAllPagerFlags(db);
drh9b0cf342015-11-12 14:57:19 +0000876 }
877 break;
878 }
879
880 /*
881 ** PRAGMA [schema.]mmap_size(N)
dan5d8a1372013-03-19 19:28:06 +0000882 **
drh0d0614b2013-03-25 23:09:28 +0000883 ** Used to set mapping size limit. The mapping size limit is
dan5d8a1372013-03-19 19:28:06 +0000884 ** used to limit the aggregate size of all memory mapped regions of the
885 ** database file. If this parameter is set to zero, then memory mapping
drha1f42c72013-04-01 22:38:06 +0000886 ** is not used at all. If N is negative, then the default memory map
drh9b4c59f2013-04-15 17:03:42 +0000887 ** limit determined by sqlite3_config(SQLITE_CONFIG_MMAP_SIZE) is set.
drha1f42c72013-04-01 22:38:06 +0000888 ** The parameter N is measured in bytes.
dan5d8a1372013-03-19 19:28:06 +0000889 **
drh0d0614b2013-03-25 23:09:28 +0000890 ** This value is advisory. The underlying VFS is free to memory map
891 ** as little or as much as it wants. Except, if N is set to 0 then the
892 ** upper layers will never invoke the xFetch interfaces to the VFS.
dan5d8a1372013-03-19 19:28:06 +0000893 */
drh9ccd8652013-09-13 16:36:46 +0000894 case PragTyp_MMAP_SIZE: {
drh9b4c59f2013-04-15 17:03:42 +0000895 sqlite3_int64 sz;
mistachkine98844f2013-08-24 00:59:24 +0000896#if SQLITE_MAX_MMAP_SIZE>0
dan5d8a1372013-03-19 19:28:06 +0000897 assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
drh0d0614b2013-03-25 23:09:28 +0000898 if( zRight ){
drha1f42c72013-04-01 22:38:06 +0000899 int ii;
drh9296c182014-07-23 13:40:49 +0000900 sqlite3DecOrHexToI64(zRight, &sz);
drh9b4c59f2013-04-15 17:03:42 +0000901 if( sz<0 ) sz = sqlite3GlobalConfig.szMmap;
902 if( pId2->n==0 ) db->szMmap = sz;
drha1f42c72013-04-01 22:38:06 +0000903 for(ii=db->nDb-1; ii>=0; ii--){
904 if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
drh9b4c59f2013-04-15 17:03:42 +0000905 sqlite3BtreeSetMmapLimit(db->aDb[ii].pBt, sz);
drha1f42c72013-04-01 22:38:06 +0000906 }
907 }
dan5d8a1372013-03-19 19:28:06 +0000908 }
drh9b4c59f2013-04-15 17:03:42 +0000909 sz = -1;
dan3719f5f2013-05-23 10:13:18 +0000910 rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_MMAP_SIZE, &sz);
mistachkine98844f2013-08-24 00:59:24 +0000911#else
dan3719f5f2013-05-23 10:13:18 +0000912 sz = 0;
mistachkine98844f2013-08-24 00:59:24 +0000913 rc = SQLITE_OK;
drh188d4882013-04-08 20:47:49 +0000914#endif
dan3719f5f2013-05-23 10:13:18 +0000915 if( rc==SQLITE_OK ){
drhc232aca2016-12-15 16:01:17 +0000916 returnSingleInt(v, sz);
dan3719f5f2013-05-23 10:13:18 +0000917 }else if( rc!=SQLITE_NOTFOUND ){
918 pParse->nErr++;
919 pParse->rc = rc;
drh34f74902013-04-03 13:09:18 +0000920 }
drh9ccd8652013-09-13 16:36:46 +0000921 break;
922 }
dan5d8a1372013-03-19 19:28:06 +0000923
924 /*
drh90f5ecb2004-07-22 01:19:35 +0000925 ** PRAGMA temp_store
926 ** PRAGMA temp_store = "default"|"memory"|"file"
927 **
928 ** Return or set the local value of the temp_store flag. Changing
929 ** the local value does not make changes to the disk file and the default
930 ** value will be restored the next time the database is opened.
931 **
932 ** Note that it is possible for the library compile-time options to
933 ** override this setting
934 */
drh9ccd8652013-09-13 16:36:46 +0000935 case PragTyp_TEMP_STORE: {
drh90f5ecb2004-07-22 01:19:35 +0000936 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +0000937 returnSingleInt(v, db->temp_store);
drh90f5ecb2004-07-22 01:19:35 +0000938 }else{
939 changeTempStorage(pParse, zRight);
940 }
drh9ccd8652013-09-13 16:36:46 +0000941 break;
942 }
drh90f5ecb2004-07-22 01:19:35 +0000943
944 /*
tpoindex9a09a3c2004-12-20 19:01:32 +0000945 ** PRAGMA temp_store_directory
946 ** PRAGMA temp_store_directory = ""|"directory_name"
947 **
948 ** Return or set the local value of the temp_store_directory flag. Changing
949 ** the value sets a specific directory to be used for temporary files.
950 ** Setting to a null string reverts to the default temporary directory search.
951 ** If temporary directory is changed, then invalidateTempStorage.
952 **
953 */
drh9ccd8652013-09-13 16:36:46 +0000954 case PragTyp_TEMP_STORE_DIRECTORY: {
tpoindex9a09a3c2004-12-20 19:01:32 +0000955 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +0000956 returnSingleText(v, sqlite3_temp_directory);
tpoindex9a09a3c2004-12-20 19:01:32 +0000957 }else{
drh78f82d12008-09-02 00:52:52 +0000958#ifndef SQLITE_OMIT_WSD
danielk1977861f7452008-06-05 11:39:11 +0000959 if( zRight[0] ){
960 int res;
danielk1977fab11272008-09-16 14:38:02 +0000961 rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
962 if( rc!=SQLITE_OK || res==0 ){
danielk1977861f7452008-06-05 11:39:11 +0000963 sqlite3ErrorMsg(pParse, "not a writable directory");
964 goto pragma_out;
965 }
drh268283b2005-01-08 15:44:25 +0000966 }
danielk1977b06a0b62008-06-26 10:54:12 +0000967 if( SQLITE_TEMP_STORE==0
968 || (SQLITE_TEMP_STORE==1 && db->temp_store<=1)
969 || (SQLITE_TEMP_STORE==2 && db->temp_store==1)
drh268283b2005-01-08 15:44:25 +0000970 ){
971 invalidateTempStorage(pParse);
972 }
drh17435752007-08-16 04:30:38 +0000973 sqlite3_free(sqlite3_temp_directory);
drh268283b2005-01-08 15:44:25 +0000974 if( zRight[0] ){
drhb9755982010-07-24 16:34:37 +0000975 sqlite3_temp_directory = sqlite3_mprintf("%s", zRight);
tpoindex9a09a3c2004-12-20 19:01:32 +0000976 }else{
drh268283b2005-01-08 15:44:25 +0000977 sqlite3_temp_directory = 0;
tpoindex9a09a3c2004-12-20 19:01:32 +0000978 }
drh78f82d12008-09-02 00:52:52 +0000979#endif /* SQLITE_OMIT_WSD */
tpoindex9a09a3c2004-12-20 19:01:32 +0000980 }
drh9ccd8652013-09-13 16:36:46 +0000981 break;
982 }
tpoindex9a09a3c2004-12-20 19:01:32 +0000983
drhcc716452012-06-06 23:23:23 +0000984#if SQLITE_OS_WIN
mistachkina112d142012-03-14 00:44:01 +0000985 /*
986 ** PRAGMA data_store_directory
987 ** PRAGMA data_store_directory = ""|"directory_name"
988 **
989 ** Return or set the local value of the data_store_directory flag. Changing
990 ** the value sets a specific directory to be used for database files that
991 ** were specified with a relative pathname. Setting to a null string reverts
992 ** to the default database directory, which for database files specified with
993 ** a relative path will probably be based on the current directory for the
994 ** process. Database file specified with an absolute path are not impacted
995 ** by this setting, regardless of its value.
996 **
997 */
drh9ccd8652013-09-13 16:36:46 +0000998 case PragTyp_DATA_STORE_DIRECTORY: {
mistachkina112d142012-03-14 00:44:01 +0000999 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +00001000 returnSingleText(v, sqlite3_data_directory);
mistachkina112d142012-03-14 00:44:01 +00001001 }else{
1002#ifndef SQLITE_OMIT_WSD
1003 if( zRight[0] ){
1004 int res;
1005 rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
1006 if( rc!=SQLITE_OK || res==0 ){
1007 sqlite3ErrorMsg(pParse, "not a writable directory");
1008 goto pragma_out;
1009 }
1010 }
1011 sqlite3_free(sqlite3_data_directory);
1012 if( zRight[0] ){
1013 sqlite3_data_directory = sqlite3_mprintf("%s", zRight);
1014 }else{
1015 sqlite3_data_directory = 0;
1016 }
1017#endif /* SQLITE_OMIT_WSD */
1018 }
drh9ccd8652013-09-13 16:36:46 +00001019 break;
1020 }
drhcc716452012-06-06 23:23:23 +00001021#endif
mistachkina112d142012-03-14 00:44:01 +00001022
drhd2cb50b2009-01-09 21:41:17 +00001023#if SQLITE_ENABLE_LOCKING_STYLE
tpoindex9a09a3c2004-12-20 19:01:32 +00001024 /*
drh9b0cf342015-11-12 14:57:19 +00001025 ** PRAGMA [schema.]lock_proxy_file
1026 ** PRAGMA [schema.]lock_proxy_file = ":auto:"|"lock_file_path"
drh9ccd8652013-09-13 16:36:46 +00001027 **
1028 ** Return or set the value of the lock_proxy_file flag. Changing
1029 ** the value sets a specific file to be used for database access locks.
1030 **
1031 */
1032 case PragTyp_LOCK_PROXY_FILE: {
aswiftaebf4132008-11-21 00:10:35 +00001033 if( !zRight ){
1034 Pager *pPager = sqlite3BtreePager(pDb->pBt);
1035 char *proxy_file_path = NULL;
1036 sqlite3_file *pFile = sqlite3PagerFile(pPager);
drhc02372c2012-01-10 17:59:59 +00001037 sqlite3OsFileControlHint(pFile, SQLITE_GET_LOCKPROXYFILE,
aswiftaebf4132008-11-21 00:10:35 +00001038 &proxy_file_path);
drhc232aca2016-12-15 16:01:17 +00001039 returnSingleText(v, proxy_file_path);
aswiftaebf4132008-11-21 00:10:35 +00001040 }else{
1041 Pager *pPager = sqlite3BtreePager(pDb->pBt);
1042 sqlite3_file *pFile = sqlite3PagerFile(pPager);
1043 int res;
1044 if( zRight[0] ){
1045 res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
1046 zRight);
1047 } else {
1048 res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
1049 NULL);
1050 }
1051 if( res!=SQLITE_OK ){
1052 sqlite3ErrorMsg(pParse, "failed to set lock proxy file");
1053 goto pragma_out;
1054 }
1055 }
drh9ccd8652013-09-13 16:36:46 +00001056 break;
1057 }
drhd2cb50b2009-01-09 21:41:17 +00001058#endif /* SQLITE_ENABLE_LOCKING_STYLE */
aswiftaebf4132008-11-21 00:10:35 +00001059
1060 /*
drh9b0cf342015-11-12 14:57:19 +00001061 ** PRAGMA [schema.]synchronous
drh6841b1c2016-02-03 19:20:15 +00001062 ** PRAGMA [schema.]synchronous=OFF|ON|NORMAL|FULL|EXTRA
drhc11d4f92003-04-06 21:08:24 +00001063 **
1064 ** Return or set the local value of the synchronous flag. Changing
1065 ** the local value does not make changes to the disk file and the
1066 ** default value will be restored the next time the database is
1067 ** opened.
1068 */
drh9ccd8652013-09-13 16:36:46 +00001069 case PragTyp_SYNCHRONOUS: {
danielk197791cf71b2004-06-26 06:37:06 +00001070 if( !zRight ){
drhc232aca2016-12-15 16:01:17 +00001071 returnSingleInt(v, pDb->safety_level-1);
drhc11d4f92003-04-06 21:08:24 +00001072 }else{
danielk197791cf71b2004-06-26 06:37:06 +00001073 if( !db->autoCommit ){
1074 sqlite3ErrorMsg(pParse,
1075 "Safety level may not be changed inside a transaction");
drh7553c822017-03-15 14:04:03 +00001076 }else if( iDb!=1 ){
drhd99d2832015-04-17 15:58:33 +00001077 int iLevel = (getSafetyLevel(zRight,0,1)+1) & PAGER_SYNCHRONOUS_MASK;
1078 if( iLevel==0 ) iLevel = 1;
1079 pDb->safety_level = iLevel;
drh50a1a5a2016-03-08 14:40:11 +00001080 pDb->bSyncSet = 1;
drhd3605a42013-08-17 15:42:29 +00001081 setAllPagerFlags(db);
danielk197791cf71b2004-06-26 06:37:06 +00001082 }
drhc11d4f92003-04-06 21:08:24 +00001083 }
drh9ccd8652013-09-13 16:36:46 +00001084 break;
1085 }
drh13d70422004-11-13 15:59:14 +00001086#endif /* SQLITE_OMIT_PAGER_PRAGMAS */
drhc11d4f92003-04-06 21:08:24 +00001087
drhbf216272005-02-26 18:10:44 +00001088#ifndef SQLITE_OMIT_FLAG_PRAGMAS
drh9ccd8652013-09-13 16:36:46 +00001089 case PragTyp_FLAG: {
1090 if( zRight==0 ){
drhc232aca2016-12-15 16:01:17 +00001091 setPragmaResultColumnNames(v, pPragma);
1092 returnSingleInt(v, (db->flags & pPragma->iArg)!=0 );
drh9ccd8652013-09-13 16:36:46 +00001093 }else{
drhfd748c62018-10-30 16:25:35 +00001094 u64 mask = pPragma->iArg; /* Mask of bits to set or clear. */
drh9ccd8652013-09-13 16:36:46 +00001095 if( db->autoCommit==0 ){
1096 /* Foreign key support may not be enabled or disabled while not
1097 ** in auto-commit mode. */
1098 mask &= ~(SQLITE_ForeignKeys);
1099 }
drhd4530972014-09-09 14:47:53 +00001100#if SQLITE_USER_AUTHENTICATION
drhb2445d52014-09-11 14:01:41 +00001101 if( db->auth.authLevel==UAUTH_User ){
drhd4530972014-09-09 14:47:53 +00001102 /* Do not allow non-admin users to modify the schema arbitrarily */
1103 mask &= ~(SQLITE_WriteSchema);
1104 }
1105#endif
drh9ccd8652013-09-13 16:36:46 +00001106
1107 if( sqlite3GetBoolean(zRight, 0) ){
drh2eeca202020-01-08 20:37:45 +00001108 db->flags |= mask;
drh9ccd8652013-09-13 16:36:46 +00001109 }else{
1110 db->flags &= ~mask;
1111 if( mask==SQLITE_DeferFKs ) db->nDeferredImmCons = 0;
1112 }
1113
1114 /* Many of the flag-pragmas modify the code generated by the SQL
1115 ** compiler (eg. count_changes). So add an opcode to expire all
1116 ** compiled SQL statements after modifying a pragma value.
1117 */
drh01c736d2016-05-20 15:15:07 +00001118 sqlite3VdbeAddOp0(v, OP_Expire);
drh9ccd8652013-09-13 16:36:46 +00001119 setAllPagerFlags(db);
1120 }
1121 break;
1122 }
drhbf216272005-02-26 18:10:44 +00001123#endif /* SQLITE_OMIT_FLAG_PRAGMAS */
drhc11d4f92003-04-06 21:08:24 +00001124
drh13d70422004-11-13 15:59:14 +00001125#ifndef SQLITE_OMIT_SCHEMA_PRAGMAS
danielk197791cf71b2004-06-26 06:37:06 +00001126 /*
1127 ** PRAGMA table_info(<table>)
1128 **
1129 ** Return a single row for each column of the named table. The columns of
1130 ** the returned data set are:
1131 **
1132 ** cid: Column id (numbered from left to right, starting at 0)
1133 ** name: Column name
1134 ** type: Column declaration type.
1135 ** notnull: True if 'NOT NULL' is part of column declaration
1136 ** dflt_value: The default value for the column, if any.
dan3e6ac162016-02-11 21:01:16 +00001137 ** pk: Non-zero for PK fields.
danielk197791cf71b2004-06-26 06:37:06 +00001138 */
drh9ccd8652013-09-13 16:36:46 +00001139 case PragTyp_TABLE_INFO: if( zRight ){
drhc11d4f92003-04-06 21:08:24 +00001140 Table *pTab;
drh4d249e62016-06-10 22:49:01 +00001141 pTab = sqlite3LocateTable(pParse, LOCATE_NOERR, zRight, zDb);
drhc11d4f92003-04-06 21:08:24 +00001142 if( pTab ){
dan3c425482018-11-20 18:09:59 +00001143 int iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drh384b7fe2013-01-01 13:55:31 +00001144 int i, k;
danielk1977034ca142007-06-26 10:38:54 +00001145 int nHidden = 0;
drhf7eece62006-02-06 21:34:27 +00001146 Column *pCol;
drh44156282013-10-23 22:23:03 +00001147 Index *pPk = sqlite3PrimaryKeyIndex(pTab);
drhd7dc0a32018-10-01 18:28:42 +00001148 pParse->nMem = 7;
dan3c425482018-11-20 18:09:59 +00001149 sqlite3CodeVerifySchema(pParse, iTabDb);
danielk19774adee202004-05-08 08:23:19 +00001150 sqlite3ViewGetColumnNames(pParse, pTab);
drhf7eece62006-02-06 21:34:27 +00001151 for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
drhab3c5f22019-10-17 13:15:40 +00001152 int isHidden = 0;
1153 if( pCol->colFlags & COLFLAG_NOINSERT ){
drh676fa252019-10-17 14:21:07 +00001154 if( pPragma->iArg==0 ){
1155 nHidden++;
1156 continue;
1157 }
drhab3c5f22019-10-17 13:15:40 +00001158 if( pCol->colFlags & COLFLAG_VIRTUAL ){
1159 isHidden = 2; /* GENERATED ALWAYS AS ... VIRTUAL */
drhc1431142019-10-17 17:54:05 +00001160 }else if( pCol->colFlags & COLFLAG_STORED ){
drhab3c5f22019-10-17 13:15:40 +00001161 isHidden = 3; /* GENERATED ALWAYS AS ... STORED */
drhc1431142019-10-17 17:54:05 +00001162 }else{ assert( pCol->colFlags & COLFLAG_HIDDEN );
drhab3c5f22019-10-17 13:15:40 +00001163 isHidden = 1; /* HIDDEN */
1164 }
danielk1977034ca142007-06-26 10:38:54 +00001165 }
drh384b7fe2013-01-01 13:55:31 +00001166 if( (pCol->colFlags & COLFLAG_PRIMKEY)==0 ){
1167 k = 0;
1168 }else if( pPk==0 ){
1169 k = 1;
1170 }else{
drh1b678962015-04-15 07:19:27 +00001171 for(k=1; k<=pTab->nCol && pPk->aiColumn[k-1]!=i; k++){}
drh384b7fe2013-01-01 13:55:31 +00001172 }
drhab3c5f22019-10-17 13:15:40 +00001173 assert( pCol->pDflt==0 || pCol->pDflt->op==TK_SPAN || isHidden>=2 );
drhd7dc0a32018-10-01 18:28:42 +00001174 sqlite3VdbeMultiLoad(v, 1, pPragma->iArg ? "issisii" : "issisi",
drh076e85f2015-09-03 13:46:12 +00001175 i-nHidden,
drhd7564862016-03-22 20:05:09 +00001176 pCol->zName,
1177 sqlite3ColumnType(pCol,""),
drh076e85f2015-09-03 13:46:12 +00001178 pCol->notNull ? 1 : 0,
drhab3c5f22019-10-17 13:15:40 +00001179 pCol->pDflt && isHidden<2 ? pCol->pDflt->u.zToken : 0,
drhd7dc0a32018-10-01 18:28:42 +00001180 k,
1181 isHidden);
drhc11d4f92003-04-06 21:08:24 +00001182 }
1183 }
drh9ccd8652013-09-13 16:36:46 +00001184 }
1185 break;
drhc11d4f92003-04-06 21:08:24 +00001186
drh33bec3f2017-02-17 13:38:15 +00001187#ifdef SQLITE_DEBUG
drh3ef26152013-10-12 20:22:00 +00001188 case PragTyp_STATS: {
1189 Index *pIdx;
1190 HashElem *i;
drh33bec3f2017-02-17 13:38:15 +00001191 pParse->nMem = 5;
drh3ef26152013-10-12 20:22:00 +00001192 sqlite3CodeVerifySchema(pParse, iDb);
drh3ef26152013-10-12 20:22:00 +00001193 for(i=sqliteHashFirst(&pDb->pSchema->tblHash); i; i=sqliteHashNext(i)){
1194 Table *pTab = sqliteHashData(i);
drh33bec3f2017-02-17 13:38:15 +00001195 sqlite3VdbeMultiLoad(v, 1, "ssiii",
drh076e85f2015-09-03 13:46:12 +00001196 pTab->zName,
1197 0,
drhd566c952016-02-25 21:19:03 +00001198 pTab->szTabRow,
drh33bec3f2017-02-17 13:38:15 +00001199 pTab->nRowLogEst,
1200 pTab->tabFlags);
drh3ef26152013-10-12 20:22:00 +00001201 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drh40cf27c2017-07-07 16:00:53 +00001202 sqlite3VdbeMultiLoad(v, 2, "siiiX",
drh076e85f2015-09-03 13:46:12 +00001203 pIdx->zName,
drhd566c952016-02-25 21:19:03 +00001204 pIdx->szIdxRow,
drh33bec3f2017-02-17 13:38:15 +00001205 pIdx->aiRowLogEst[0],
1206 pIdx->hasStat1);
1207 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
drh3ef26152013-10-12 20:22:00 +00001208 }
1209 }
1210 }
1211 break;
drh33bec3f2017-02-17 13:38:15 +00001212#endif
drh3ef26152013-10-12 20:22:00 +00001213
drh9ccd8652013-09-13 16:36:46 +00001214 case PragTyp_INDEX_INFO: if( zRight ){
drhc11d4f92003-04-06 21:08:24 +00001215 Index *pIdx;
1216 Table *pTab;
drh2783e4b2004-10-05 15:42:53 +00001217 pIdx = sqlite3FindIndex(db, zRight, zDb);
drh7b1904e2019-07-17 11:01:11 +00001218 if( pIdx==0 ){
1219 /* If there is no index named zRight, check to see if there is a
1220 ** WITHOUT ROWID table named zRight, and if there is, show the
1221 ** structure of the PRIMARY KEY index for that table. */
1222 pTab = sqlite3LocateTable(pParse, LOCATE_NOERR, zRight, zDb);
1223 if( pTab && !HasRowid(pTab) ){
1224 pIdx = sqlite3PrimaryKeyIndex(pTab);
1225 }
1226 }
drhc11d4f92003-04-06 21:08:24 +00001227 if( pIdx ){
dan3c425482018-11-20 18:09:59 +00001228 int iIdxDb = sqlite3SchemaToIndex(db, pIdx->pSchema);
drhc11d4f92003-04-06 21:08:24 +00001229 int i;
drh5e7028c2015-03-05 14:29:02 +00001230 int mx;
1231 if( pPragma->iArg ){
1232 /* PRAGMA index_xinfo (newer version with more rows and columns) */
1233 mx = pIdx->nColumn;
1234 pParse->nMem = 6;
1235 }else{
1236 /* PRAGMA index_info (legacy version) */
1237 mx = pIdx->nKeyCol;
1238 pParse->nMem = 3;
1239 }
drhc11d4f92003-04-06 21:08:24 +00001240 pTab = pIdx->pTable;
dan3c425482018-11-20 18:09:59 +00001241 sqlite3CodeVerifySchema(pParse, iIdxDb);
drhc232aca2016-12-15 16:01:17 +00001242 assert( pParse->nMem<=pPragma->nPragCName );
drhc228be52015-01-31 02:00:01 +00001243 for(i=0; i<mx; i++){
drhbbbdc832013-10-22 18:01:40 +00001244 i16 cnum = pIdx->aiColumn[i];
drh40cf27c2017-07-07 16:00:53 +00001245 sqlite3VdbeMultiLoad(v, 1, "iisX", i, cnum,
drh076e85f2015-09-03 13:46:12 +00001246 cnum<0 ? 0 : pTab->aCol[cnum].zName);
drh5e7028c2015-03-05 14:29:02 +00001247 if( pPragma->iArg ){
drh40cf27c2017-07-07 16:00:53 +00001248 sqlite3VdbeMultiLoad(v, 4, "isiX",
drh076e85f2015-09-03 13:46:12 +00001249 pIdx->aSortOrder[i],
1250 pIdx->azColl[i],
1251 i<pIdx->nKeyCol);
drh5e7028c2015-03-05 14:29:02 +00001252 }
1253 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, pParse->nMem);
drhc11d4f92003-04-06 21:08:24 +00001254 }
1255 }
drh9ccd8652013-09-13 16:36:46 +00001256 }
1257 break;
drhc11d4f92003-04-06 21:08:24 +00001258
drh9ccd8652013-09-13 16:36:46 +00001259 case PragTyp_INDEX_LIST: if( zRight ){
drhc11d4f92003-04-06 21:08:24 +00001260 Index *pIdx;
1261 Table *pTab;
drhe13e9f52013-10-05 19:18:00 +00001262 int i;
drh2783e4b2004-10-05 15:42:53 +00001263 pTab = sqlite3FindTable(db, zRight, zDb);
drhc11d4f92003-04-06 21:08:24 +00001264 if( pTab ){
dan3c425482018-11-20 18:09:59 +00001265 int iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
drhc228be52015-01-31 02:00:01 +00001266 pParse->nMem = 5;
dan3c425482018-11-20 18:09:59 +00001267 sqlite3CodeVerifySchema(pParse, iTabDb);
drh3ef26152013-10-12 20:22:00 +00001268 for(pIdx=pTab->pIndex, i=0; pIdx; pIdx=pIdx->pNext, i++){
drhc228be52015-01-31 02:00:01 +00001269 const char *azOrigin[] = { "c", "u", "pk" };
drh076e85f2015-09-03 13:46:12 +00001270 sqlite3VdbeMultiLoad(v, 1, "isisi",
1271 i,
1272 pIdx->zName,
1273 IsUniqueIndex(pIdx),
1274 azOrigin[pIdx->idxType],
1275 pIdx->pPartIdxWhere!=0);
drhc11d4f92003-04-06 21:08:24 +00001276 }
1277 }
drh9ccd8652013-09-13 16:36:46 +00001278 }
1279 break;
drhc11d4f92003-04-06 21:08:24 +00001280
drh9ccd8652013-09-13 16:36:46 +00001281 case PragTyp_DATABASE_LIST: {
drh13d70422004-11-13 15:59:14 +00001282 int i;
drh2d401ab2008-01-10 23:50:11 +00001283 pParse->nMem = 3;
drh13d70422004-11-13 15:59:14 +00001284 for(i=0; i<db->nDb; i++){
1285 if( db->aDb[i].pBt==0 ) continue;
drh69c33822016-08-18 14:33:11 +00001286 assert( db->aDb[i].zDbSName!=0 );
drh076e85f2015-09-03 13:46:12 +00001287 sqlite3VdbeMultiLoad(v, 1, "iss",
1288 i,
drh69c33822016-08-18 14:33:11 +00001289 db->aDb[i].zDbSName,
drh076e85f2015-09-03 13:46:12 +00001290 sqlite3BtreeGetFilename(db->aDb[i].pBt));
drh13d70422004-11-13 15:59:14 +00001291 }
drh9ccd8652013-09-13 16:36:46 +00001292 }
1293 break;
danielk197748af65a2005-02-09 03:20:37 +00001294
drh9ccd8652013-09-13 16:36:46 +00001295 case PragTyp_COLLATION_LIST: {
danielk197748af65a2005-02-09 03:20:37 +00001296 int i = 0;
1297 HashElem *p;
drh2d401ab2008-01-10 23:50:11 +00001298 pParse->nMem = 2;
danielk197748af65a2005-02-09 03:20:37 +00001299 for(p=sqliteHashFirst(&db->aCollSeq); p; p=sqliteHashNext(p)){
1300 CollSeq *pColl = (CollSeq *)sqliteHashData(p);
drh076e85f2015-09-03 13:46:12 +00001301 sqlite3VdbeMultiLoad(v, 1, "is", i++, pColl->zName);
danielk197748af65a2005-02-09 03:20:37 +00001302 }
drh9ccd8652013-09-13 16:36:46 +00001303 }
1304 break;
drhab53bb62017-07-07 15:43:22 +00001305
drhcc3f3d12019-08-17 15:27:58 +00001306#ifndef SQLITE_OMIT_INTROSPECTION_PRAGMAS
drhab53bb62017-07-07 15:43:22 +00001307 case PragTyp_FUNCTION_LIST: {
1308 int i;
1309 HashElem *j;
1310 FuncDef *p;
drh337ca512020-01-04 19:58:28 +00001311 int showInternFunc = (db->mDbFlags & DBFLAG_InternalFunc)!=0;
drh79d5bc82020-01-04 01:43:02 +00001312 pParse->nMem = 6;
drhab53bb62017-07-07 15:43:22 +00001313 for(i=0; i<SQLITE_FUNC_HASH_SZ; i++){
1314 for(p=sqlite3BuiltinFunctions.a[i]; p; p=p->u.pHash ){
drh337ca512020-01-04 19:58:28 +00001315 pragmaFunclistLine(v, p, 1, showInternFunc);
drhab53bb62017-07-07 15:43:22 +00001316 }
1317 }
1318 for(j=sqliteHashFirst(&db->aFunc); j; j=sqliteHashNext(j)){
1319 p = (FuncDef*)sqliteHashData(j);
drh337ca512020-01-04 19:58:28 +00001320 pragmaFunclistLine(v, p, 0, showInternFunc);
drhab53bb62017-07-07 15:43:22 +00001321 }
1322 }
1323 break;
1324
1325#ifndef SQLITE_OMIT_VIRTUALTABLE
1326 case PragTyp_MODULE_LIST: {
1327 HashElem *j;
1328 pParse->nMem = 1;
1329 for(j=sqliteHashFirst(&db->aModule); j; j=sqliteHashNext(j)){
1330 Module *pMod = (Module*)sqliteHashData(j);
1331 sqlite3VdbeMultiLoad(v, 1, "s", pMod->zName);
drhab53bb62017-07-07 15:43:22 +00001332 }
1333 }
1334 break;
1335#endif /* SQLITE_OMIT_VIRTUALTABLE */
1336
drh8ae11aa2017-07-07 17:33:07 +00001337 case PragTyp_PRAGMA_LIST: {
1338 int i;
1339 for(i=0; i<ArraySize(aPragmaName); i++){
1340 sqlite3VdbeMultiLoad(v, 1, "s", aPragmaName[i].zName);
drh8ae11aa2017-07-07 17:33:07 +00001341 }
1342 }
1343 break;
1344#endif /* SQLITE_INTROSPECTION_PRAGMAS */
drhab53bb62017-07-07 15:43:22 +00001345
drh13d70422004-11-13 15:59:14 +00001346#endif /* SQLITE_OMIT_SCHEMA_PRAGMAS */
1347
drhb7f91642004-10-31 02:22:47 +00001348#ifndef SQLITE_OMIT_FOREIGN_KEY
drh9ccd8652013-09-13 16:36:46 +00001349 case PragTyp_FOREIGN_KEY_LIST: if( zRight ){
drh78100cc2003-08-23 22:40:53 +00001350 FKey *pFK;
1351 Table *pTab;
drh2783e4b2004-10-05 15:42:53 +00001352 pTab = sqlite3FindTable(db, zRight, zDb);
drh78100cc2003-08-23 22:40:53 +00001353 if( pTab ){
drh78100cc2003-08-23 22:40:53 +00001354 pFK = pTab->pFKey;
danielk1977742f9472004-06-16 12:02:43 +00001355 if( pFK ){
dan3c425482018-11-20 18:09:59 +00001356 int iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
danielk1977742f9472004-06-16 12:02:43 +00001357 int i = 0;
danielk197750af3e12008-10-10 17:47:21 +00001358 pParse->nMem = 8;
dan3c425482018-11-20 18:09:59 +00001359 sqlite3CodeVerifySchema(pParse, iTabDb);
danielk1977742f9472004-06-16 12:02:43 +00001360 while(pFK){
1361 int j;
1362 for(j=0; j<pFK->nCol; j++){
drh076e85f2015-09-03 13:46:12 +00001363 sqlite3VdbeMultiLoad(v, 1, "iissssss",
1364 i,
1365 j,
1366 pFK->zTo,
1367 pTab->aCol[pFK->aCol[j].iFrom].zName,
1368 pFK->aCol[j].zCol,
1369 actionName(pFK->aAction[1]), /* ON UPDATE */
1370 actionName(pFK->aAction[0]), /* ON DELETE */
1371 "NONE");
danielk1977742f9472004-06-16 12:02:43 +00001372 }
1373 ++i;
1374 pFK = pFK->pNextFrom;
drh78100cc2003-08-23 22:40:53 +00001375 }
drh78100cc2003-08-23 22:40:53 +00001376 }
1377 }
drh9ccd8652013-09-13 16:36:46 +00001378 }
1379 break;
drhb7f91642004-10-31 02:22:47 +00001380#endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
drh78100cc2003-08-23 22:40:53 +00001381
drh6c5b9152012-12-17 16:46:37 +00001382#ifndef SQLITE_OMIT_FOREIGN_KEY
dan09ff9e12013-03-11 11:49:03 +00001383#ifndef SQLITE_OMIT_TRIGGER
drh9ccd8652013-09-13 16:36:46 +00001384 case PragTyp_FOREIGN_KEY_CHECK: {
drh613028b2012-12-17 18:43:02 +00001385 FKey *pFK; /* A foreign key constraint */
1386 Table *pTab; /* Child table contain "REFERENCES" keyword */
1387 Table *pParent; /* Parent table that child points to */
1388 Index *pIdx; /* Index in the parent table */
1389 int i; /* Loop counter: Foreign key number for pTab */
1390 int j; /* Loop counter: Field of the foreign key */
1391 HashElem *k; /* Loop counter: Next table in schema */
1392 int x; /* result variable */
1393 int regResult; /* 3 registers to hold a result row */
1394 int regKey; /* Register to hold key for checking the FK */
1395 int regRow; /* Registers to hold a row from pTab */
1396 int addrTop; /* Top of a loop checking foreign keys */
1397 int addrOk; /* Jump here if the key is OK */
drh7d22a4d2012-12-17 22:32:14 +00001398 int *aiCols; /* child to parent column mapping */
drh6c5b9152012-12-17 16:46:37 +00001399
drh613028b2012-12-17 18:43:02 +00001400 regResult = pParse->nMem+1;
drh4b4b4732012-12-17 20:57:15 +00001401 pParse->nMem += 4;
drh613028b2012-12-17 18:43:02 +00001402 regKey = ++pParse->nMem;
1403 regRow = ++pParse->nMem;
drh613028b2012-12-17 18:43:02 +00001404 k = sqliteHashFirst(&db->aDb[iDb].pSchema->tblHash);
1405 while( k ){
dan3c425482018-11-20 18:09:59 +00001406 int iTabDb;
drh613028b2012-12-17 18:43:02 +00001407 if( zRight ){
1408 pTab = sqlite3LocateTable(pParse, 0, zRight, zDb);
1409 k = 0;
1410 }else{
1411 pTab = (Table*)sqliteHashData(k);
1412 k = sqliteHashNext(k);
1413 }
drh9148def2012-12-17 20:40:39 +00001414 if( pTab==0 || pTab->pFKey==0 ) continue;
dan3c425482018-11-20 18:09:59 +00001415 iTabDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1416 sqlite3CodeVerifySchema(pParse, iTabDb);
1417 sqlite3TableLock(pParse, iTabDb, pTab->tnum, 0, pTab->zName);
drh613028b2012-12-17 18:43:02 +00001418 if( pTab->nCol+regRow>pParse->nMem ) pParse->nMem = pTab->nCol + regRow;
dan3c425482018-11-20 18:09:59 +00001419 sqlite3OpenTable(pParse, 0, iTabDb, pTab, OP_OpenRead);
drh076e85f2015-09-03 13:46:12 +00001420 sqlite3VdbeLoadString(v, regResult, pTab->zName);
drh6c5b9152012-12-17 16:46:37 +00001421 for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
dan5e878302013-10-12 19:06:48 +00001422 pParent = sqlite3FindTable(db, pFK->zTo, zDb);
1423 if( pParent==0 ) continue;
drh6c5b9152012-12-17 16:46:37 +00001424 pIdx = 0;
dan3c425482018-11-20 18:09:59 +00001425 sqlite3TableLock(pParse, iTabDb, pParent->tnum, 0, pParent->zName);
drh613028b2012-12-17 18:43:02 +00001426 x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, 0);
drh6c5b9152012-12-17 16:46:37 +00001427 if( x==0 ){
1428 if( pIdx==0 ){
dan3c425482018-11-20 18:09:59 +00001429 sqlite3OpenTable(pParse, i, iTabDb, pParent, OP_OpenRead);
drh6c5b9152012-12-17 16:46:37 +00001430 }else{
dan3c425482018-11-20 18:09:59 +00001431 sqlite3VdbeAddOp3(v, OP_OpenRead, i, pIdx->tnum, iTabDb);
drh2ec2fb22013-11-06 19:59:23 +00001432 sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
drh6c5b9152012-12-17 16:46:37 +00001433 }
1434 }else{
drh613028b2012-12-17 18:43:02 +00001435 k = 0;
drh6c5b9152012-12-17 16:46:37 +00001436 break;
1437 }
drh6c5b9152012-12-17 16:46:37 +00001438 }
dan5e878302013-10-12 19:06:48 +00001439 assert( pParse->nErr>0 || pFK==0 );
drh613028b2012-12-17 18:43:02 +00001440 if( pFK ) break;
1441 if( pParse->nTab<i ) pParse->nTab = i;
drh688852a2014-02-17 22:40:43 +00001442 addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, 0); VdbeCoverage(v);
drh613028b2012-12-17 18:43:02 +00001443 for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
dan5e878302013-10-12 19:06:48 +00001444 pParent = sqlite3FindTable(db, pFK->zTo, zDb);
drh613028b2012-12-17 18:43:02 +00001445 pIdx = 0;
drh7d22a4d2012-12-17 22:32:14 +00001446 aiCols = 0;
dan5e878302013-10-12 19:06:48 +00001447 if( pParent ){
1448 x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, &aiCols);
1449 assert( x==0 );
1450 }
drhec4ccdb2018-12-29 02:26:59 +00001451 addrOk = sqlite3VdbeMakeLabel(pParse);
dan4bee5592017-04-17 18:42:33 +00001452
1453 /* Generate code to read the child key values into registers
1454 ** regRow..regRow+n. If any of the child key values are NULL, this
1455 ** row cannot cause an FK violation. Jump directly to addrOk in
1456 ** this case. */
1457 for(j=0; j<pFK->nCol; j++){
1458 int iCol = aiCols ? aiCols[j] : pFK->aCol[j].iFrom;
1459 sqlite3ExprCodeGetColumnOfTable(v, pTab, 0, iCol, regRow+j);
1460 sqlite3VdbeAddOp2(v, OP_IsNull, regRow+j, addrOk); VdbeCoverage(v);
drh6c5b9152012-12-17 16:46:37 +00001461 }
dan4bee5592017-04-17 18:42:33 +00001462
1463 /* Generate code to query the parent index for a matching parent
1464 ** key. If a match is found, jump to addrOk. */
1465 if( pIdx ){
1466 sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, pFK->nCol, regKey,
1467 sqlite3IndexAffinityStr(db,pIdx), pFK->nCol);
1468 sqlite3VdbeAddOp4Int(v, OP_Found, i, addrOk, regKey, 0);
1469 VdbeCoverage(v);
1470 }else if( pParent ){
1471 int jmp = sqlite3VdbeCurrentAddr(v)+2;
1472 sqlite3VdbeAddOp3(v, OP_SeekRowid, i, jmp, regRow); VdbeCoverage(v);
1473 sqlite3VdbeGoto(v, addrOk);
1474 assert( pFK->nCol==1 );
1475 }
1476
1477 /* Generate code to report an FK violation to the caller. */
dan940464b2017-04-17 18:02:41 +00001478 if( HasRowid(pTab) ){
1479 sqlite3VdbeAddOp2(v, OP_Rowid, 0, regResult+1);
1480 }else{
1481 sqlite3VdbeAddOp2(v, OP_Null, 0, regResult+1);
1482 }
drh40cf27c2017-07-07 16:00:53 +00001483 sqlite3VdbeMultiLoad(v, regResult+2, "siX", pFK->zTo, i-1);
drh4b4b4732012-12-17 20:57:15 +00001484 sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, 4);
drh613028b2012-12-17 18:43:02 +00001485 sqlite3VdbeResolveLabel(v, addrOk);
drh7d22a4d2012-12-17 22:32:14 +00001486 sqlite3DbFree(db, aiCols);
drh6c5b9152012-12-17 16:46:37 +00001487 }
drh688852a2014-02-17 22:40:43 +00001488 sqlite3VdbeAddOp2(v, OP_Next, 0, addrTop+1); VdbeCoverage(v);
drh613028b2012-12-17 18:43:02 +00001489 sqlite3VdbeJumpHere(v, addrTop);
drh6c5b9152012-12-17 16:46:37 +00001490 }
drh9ccd8652013-09-13 16:36:46 +00001491 }
1492 break;
dan09ff9e12013-03-11 11:49:03 +00001493#endif /* !defined(SQLITE_OMIT_TRIGGER) */
drh6c5b9152012-12-17 16:46:37 +00001494#endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
1495
drh08652b52019-05-08 17:27:18 +00001496#ifndef SQLITE_OMIT_CASE_SENSITIVE_LIKE_PRAGMA
drh55ef4d92005-08-14 01:20:37 +00001497 /* Reinstall the LIKE and GLOB functions. The variant of LIKE
1498 ** used will be case sensitive or not depending on the RHS.
1499 */
drh9ccd8652013-09-13 16:36:46 +00001500 case PragTyp_CASE_SENSITIVE_LIKE: {
drh55ef4d92005-08-14 01:20:37 +00001501 if( zRight ){
drh38d9c612012-01-31 14:24:47 +00001502 sqlite3RegisterLikeFunctions(db, sqlite3GetBoolean(zRight, 0));
drh55ef4d92005-08-14 01:20:37 +00001503 }
drh9ccd8652013-09-13 16:36:46 +00001504 }
1505 break;
drh08652b52019-05-08 17:27:18 +00001506#endif /* SQLITE_OMIT_CASE_SENSITIVE_LIKE_PRAGMA */
drh55ef4d92005-08-14 01:20:37 +00001507
drh1dcdbc02007-01-27 02:24:54 +00001508#ifndef SQLITE_INTEGRITY_CHECK_ERROR_MAX
1509# define SQLITE_INTEGRITY_CHECK_ERROR_MAX 100
1510#endif
1511
drhb7f91642004-10-31 02:22:47 +00001512#ifndef SQLITE_OMIT_INTEGRITY_CHECK
drh8b174f22017-02-22 15:11:36 +00001513 /* PRAGMA integrity_check
1514 ** PRAGMA integrity_check(N)
1515 ** PRAGMA quick_check
1516 ** PRAGMA quick_check(N)
1517 **
1518 ** Verify the integrity of the database.
1519 **
1520 ** The "quick_check" is reduced version of
danielk197741c58b72007-12-29 13:39:19 +00001521 ** integrity_check designed to detect most database corruption
drh8b174f22017-02-22 15:11:36 +00001522 ** without the overhead of cross-checking indexes. Quick_check
1523 ** is linear time wherease integrity_check is O(NlogN).
danielk197741c58b72007-12-29 13:39:19 +00001524 */
drh9ccd8652013-09-13 16:36:46 +00001525 case PragTyp_INTEGRITY_CHECK: {
drh1dcdbc02007-01-27 02:24:54 +00001526 int i, j, addr, mxErr;
drhed717fe2003-06-15 23:42:24 +00001527
drhc5227312011-10-13 17:09:01 +00001528 int isQuick = (sqlite3Tolower(zLeft[0])=='q');
danielk197741c58b72007-12-29 13:39:19 +00001529
dan5885e762012-07-16 10:06:12 +00001530 /* If the PRAGMA command was of the form "PRAGMA <db>.integrity_check",
1531 ** then iDb is set to the index of the database identified by <db>.
1532 ** In this case, the integrity of database iDb only is verified by
1533 ** the VDBE created below.
1534 **
1535 ** Otherwise, if the command was simply "PRAGMA integrity_check" (or
1536 ** "PRAGMA quick_check"), then iDb is set to 0. In this case, set iDb
1537 ** to -1 here, to indicate that the VDBE should verify the integrity
1538 ** of all attached databases. */
1539 assert( iDb>=0 );
1540 assert( iDb==0 || pId2->z );
1541 if( pId2->z==0 ) iDb = -1;
1542
drhed717fe2003-06-15 23:42:24 +00001543 /* Initialize the VDBE program */
drh2d401ab2008-01-10 23:50:11 +00001544 pParse->nMem = 6;
drh1dcdbc02007-01-27 02:24:54 +00001545
1546 /* Set the maximum error count */
1547 mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
1548 if( zRight ){
drh60ac3f42010-11-23 18:59:27 +00001549 sqlite3GetInt32(zRight, &mxErr);
drh1dcdbc02007-01-27 02:24:54 +00001550 if( mxErr<=0 ){
1551 mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
1552 }
1553 }
drh66accfc2017-02-22 18:04:42 +00001554 sqlite3VdbeAddOp2(v, OP_Integer, mxErr-1, 1); /* reg[1] holds errors left */
drhed717fe2003-06-15 23:42:24 +00001555
1556 /* Do an integrity check on each database file */
1557 for(i=0; i<db->nDb; i++){
drh9ecd7082017-09-10 01:06:05 +00001558 HashElem *x; /* For looping over tables in the schema */
1559 Hash *pTbls; /* Set of all tables in the schema */
1560 int *aRoot; /* Array of root page numbers of all btrees */
1561 int cnt = 0; /* Number of entries in aRoot[] */
1562 int mxIdx = 0; /* Maximum number of indexes for any table */
drhed717fe2003-06-15 23:42:24 +00001563
danielk197753c0f742005-03-29 03:10:59 +00001564 if( OMIT_TEMPDB && i==1 ) continue;
dan5885e762012-07-16 10:06:12 +00001565 if( iDb>=0 && i!=iDb ) continue;
danielk197753c0f742005-03-29 03:10:59 +00001566
drh80242052004-06-09 00:48:12 +00001567 sqlite3CodeVerifySchema(pParse, i);
1568
drhed717fe2003-06-15 23:42:24 +00001569 /* Do an integrity check of the B-Tree
drh2d401ab2008-01-10 23:50:11 +00001570 **
drh98968b22016-03-15 22:00:39 +00001571 ** Begin by finding the root pages numbers
drh2d401ab2008-01-10 23:50:11 +00001572 ** for all tables and indices in the database.
drhed717fe2003-06-15 23:42:24 +00001573 */
dan5885e762012-07-16 10:06:12 +00001574 assert( sqlite3SchemaMutexHeld(db, i, 0) );
danielk1977da184232006-01-05 11:34:32 +00001575 pTbls = &db->aDb[i].pSchema->tblHash;
drh98968b22016-03-15 22:00:39 +00001576 for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
drh9ecd7082017-09-10 01:06:05 +00001577 Table *pTab = sqliteHashData(x); /* Current table */
1578 Index *pIdx; /* An index on pTab */
1579 int nIdx; /* Number of indexes on pTab */
drh98968b22016-03-15 22:00:39 +00001580 if( HasRowid(pTab) ) cnt++;
drhbb9b5f22016-03-19 00:35:02 +00001581 for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){ cnt++; }
1582 if( nIdx>mxIdx ) mxIdx = nIdx;
drh98968b22016-03-15 22:00:39 +00001583 }
1584 aRoot = sqlite3DbMallocRawNN(db, sizeof(int)*(cnt+1));
1585 if( aRoot==0 ) break;
1586 for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
1587 Table *pTab = sqliteHashData(x);
1588 Index *pIdx;
drhb5c10632017-09-21 00:49:15 +00001589 if( HasRowid(pTab) ) aRoot[++cnt] = pTab->tnum;
drh79069752004-05-22 21:30:40 +00001590 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
drhb5c10632017-09-21 00:49:15 +00001591 aRoot[++cnt] = pIdx->tnum;
drh79069752004-05-22 21:30:40 +00001592 }
1593 }
drhb5c10632017-09-21 00:49:15 +00001594 aRoot[0] = cnt;
drh2d401ab2008-01-10 23:50:11 +00001595
1596 /* Make sure sufficient number of registers have been allocated */
drhbb9b5f22016-03-19 00:35:02 +00001597 pParse->nMem = MAX( pParse->nMem, 8+mxIdx );
drh3963e582017-07-15 20:33:19 +00001598 sqlite3ClearTempRegCache(pParse);
drh2d401ab2008-01-10 23:50:11 +00001599
1600 /* Do the b-tree integrity checks */
drh98968b22016-03-15 22:00:39 +00001601 sqlite3VdbeAddOp4(v, OP_IntegrityCk, 2, cnt, 1, (char*)aRoot,P4_INTARRAY);
drh4f21c4a2008-12-10 22:15:00 +00001602 sqlite3VdbeChangeP5(v, (u8)i);
drh688852a2014-02-17 22:40:43 +00001603 addr = sqlite3VdbeAddOp1(v, OP_IsNull, 2); VdbeCoverage(v);
drh98757152008-01-09 23:04:12 +00001604 sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0,
drh69c33822016-08-18 14:33:11 +00001605 sqlite3MPrintf(db, "*** in database %s ***\n", db->aDb[i].zDbSName),
drh66a51672008-01-03 00:01:23 +00001606 P4_DYNAMIC);
drh9ecd7082017-09-10 01:06:05 +00001607 sqlite3VdbeAddOp3(v, OP_Concat, 2, 3, 3);
1608 integrityCheckResultRow(v);
drh1dcdbc02007-01-27 02:24:54 +00001609 sqlite3VdbeJumpHere(v, addr);
drhed717fe2003-06-15 23:42:24 +00001610
1611 /* Make sure all the indices are constructed correctly.
1612 */
drh8b174f22017-02-22 15:11:36 +00001613 for(x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
drhed717fe2003-06-15 23:42:24 +00001614 Table *pTab = sqliteHashData(x);
drh6fbe41a2013-10-30 20:22:55 +00001615 Index *pIdx, *pPk;
drh1c2c0b72014-01-04 19:27:05 +00001616 Index *pPrior = 0;
drhed717fe2003-06-15 23:42:24 +00001617 int loopTop;
drh26198bb2013-10-31 11:15:09 +00001618 int iDataCur, iIdxCur;
drh1c2c0b72014-01-04 19:27:05 +00001619 int r1 = -1;
drhed717fe2003-06-15 23:42:24 +00001620
drha3b2da92017-03-17 03:21:14 +00001621 if( pTab->tnum<1 ) continue; /* Skip VIEWs or VIRTUAL TABLEs */
drh26198bb2013-10-31 11:15:09 +00001622 pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
danfd261ec2015-10-22 20:54:33 +00001623 sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenRead, 0,
drh6a534992013-11-16 20:13:39 +00001624 1, 0, &iDataCur, &iIdxCur);
drh9ecd7082017-09-10 01:06:05 +00001625 /* reg[7] counts the number of entries in the table.
1626 ** reg[8+i] counts the number of entries in the i-th index
1627 */
drh6fbe41a2013-10-30 20:22:55 +00001628 sqlite3VdbeAddOp2(v, OP_Integer, 0, 7);
drh8a9789b2013-08-01 03:36:59 +00001629 for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
drh6fbe41a2013-10-30 20:22:55 +00001630 sqlite3VdbeAddOp2(v, OP_Integer, 0, 8+j); /* index entries counter */
drh8a9789b2013-08-01 03:36:59 +00001631 }
drhbb9b5f22016-03-19 00:35:02 +00001632 assert( pParse->nMem>=8+j );
1633 assert( sqlite3NoTempsInRange(pParse,1,7+j) );
drh688852a2014-02-17 22:40:43 +00001634 sqlite3VdbeAddOp2(v, OP_Rewind, iDataCur, 0); VdbeCoverage(v);
drh6fbe41a2013-10-30 20:22:55 +00001635 loopTop = sqlite3VdbeAddOp2(v, OP_AddImm, 7, 1);
drh4011c442018-06-06 19:48:19 +00001636 if( !isQuick ){
1637 /* Sanity check on record header decoding */
drh0b0b3a92019-10-17 18:35:57 +00001638 sqlite3VdbeAddOp3(v, OP_Column, iDataCur, pTab->nNVCol-1,3);
drh4011c442018-06-06 19:48:19 +00001639 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
1640 }
drhcefc87f2014-08-01 01:40:33 +00001641 /* Verify that all NOT NULL columns really are NOT NULL */
1642 for(j=0; j<pTab->nCol; j++){
1643 char *zErr;
drh66accfc2017-02-22 18:04:42 +00001644 int jmp2;
drhcefc87f2014-08-01 01:40:33 +00001645 if( j==pTab->iPKey ) continue;
1646 if( pTab->aCol[j].notNull==0 ) continue;
1647 sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, j, 3);
drhebd70ee2019-12-09 15:52:07 +00001648 if( sqlite3VdbeGetOp(v,-1)->opcode==OP_Column ){
1649 sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
1650 }
drhcefc87f2014-08-01 01:40:33 +00001651 jmp2 = sqlite3VdbeAddOp1(v, OP_NotNull, 3); VdbeCoverage(v);
drhcefc87f2014-08-01 01:40:33 +00001652 zErr = sqlite3MPrintf(db, "NULL value in %s.%s", pTab->zName,
1653 pTab->aCol[j].zName);
1654 sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
drh9ecd7082017-09-10 01:06:05 +00001655 integrityCheckResultRow(v);
drhcefc87f2014-08-01 01:40:33 +00001656 sqlite3VdbeJumpHere(v, jmp2);
drhcefc87f2014-08-01 01:40:33 +00001657 }
drh8a284dc2017-02-22 14:15:37 +00001658 /* Verify CHECK constraints */
1659 if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
dan75f95582017-04-04 19:58:54 +00001660 ExprList *pCheck = sqlite3ExprListDup(db, pTab->pCheck, 0);
1661 if( db->mallocFailed==0 ){
drhec4ccdb2018-12-29 02:26:59 +00001662 int addrCkFault = sqlite3VdbeMakeLabel(pParse);
1663 int addrCkOk = sqlite3VdbeMakeLabel(pParse);
dan75f95582017-04-04 19:58:54 +00001664 char *zErr;
1665 int k;
drh6e97f8e2017-07-20 13:17:08 +00001666 pParse->iSelfTab = iDataCur + 1;
dan75f95582017-04-04 19:58:54 +00001667 for(k=pCheck->nExpr-1; k>0; k--){
1668 sqlite3ExprIfFalse(pParse, pCheck->a[k].pExpr, addrCkFault, 0);
1669 }
1670 sqlite3ExprIfTrue(pParse, pCheck->a[0].pExpr, addrCkOk,
1671 SQLITE_JUMPIFNULL);
1672 sqlite3VdbeResolveLabel(v, addrCkFault);
drh3e34eab2017-07-19 19:48:40 +00001673 pParse->iSelfTab = 0;
dan75f95582017-04-04 19:58:54 +00001674 zErr = sqlite3MPrintf(db, "CHECK constraint failed in %s",
1675 pTab->zName);
1676 sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
drh9ecd7082017-09-10 01:06:05 +00001677 integrityCheckResultRow(v);
dan75f95582017-04-04 19:58:54 +00001678 sqlite3VdbeResolveLabel(v, addrCkOk);
drh8a284dc2017-02-22 14:15:37 +00001679 }
dan75f95582017-04-04 19:58:54 +00001680 sqlite3ExprListDelete(db, pCheck);
drhcefc87f2014-08-01 01:40:33 +00001681 }
drh226cef42017-09-09 20:38:49 +00001682 if( !isQuick ){ /* Omit the remaining tests for quick_check */
drh226cef42017-09-09 20:38:49 +00001683 /* Validate index entries for the current row */
1684 for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
1685 int jmp2, jmp3, jmp4, jmp5;
drhec4ccdb2018-12-29 02:26:59 +00001686 int ckUniq = sqlite3VdbeMakeLabel(pParse);
drh226cef42017-09-09 20:38:49 +00001687 if( pPk==pIdx ) continue;
1688 r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 0, &jmp3,
1689 pPrior, r1);
1690 pPrior = pIdx;
1691 sqlite3VdbeAddOp2(v, OP_AddImm, 8+j, 1);/* increment entry count */
1692 /* Verify that an index entry exists for the current table row */
1693 jmp2 = sqlite3VdbeAddOp4Int(v, OP_Found, iIdxCur+j, ckUniq, r1,
1694 pIdx->nColumn); VdbeCoverage(v);
1695 sqlite3VdbeLoadString(v, 3, "row ");
1696 sqlite3VdbeAddOp3(v, OP_Concat, 7, 3, 3);
1697 sqlite3VdbeLoadString(v, 4, " missing from index ");
1698 sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
1699 jmp5 = sqlite3VdbeLoadString(v, 4, pIdx->zName);
1700 sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
drh9ecd7082017-09-10 01:06:05 +00001701 jmp4 = integrityCheckResultRow(v);
drh226cef42017-09-09 20:38:49 +00001702 sqlite3VdbeJumpHere(v, jmp2);
1703 /* For UNIQUE indexes, verify that only one entry exists with the
1704 ** current key. The entry is unique if (1) any column is NULL
1705 ** or (2) the next entry has a different key */
1706 if( IsUniqueIndex(pIdx) ){
drhec4ccdb2018-12-29 02:26:59 +00001707 int uniqOk = sqlite3VdbeMakeLabel(pParse);
drh226cef42017-09-09 20:38:49 +00001708 int jmp6;
1709 int kk;
1710 for(kk=0; kk<pIdx->nKeyCol; kk++){
1711 int iCol = pIdx->aiColumn[kk];
1712 assert( iCol!=XN_ROWID && iCol<pTab->nCol );
1713 if( iCol>=0 && pTab->aCol[iCol].notNull ) continue;
1714 sqlite3VdbeAddOp2(v, OP_IsNull, r1+kk, uniqOk);
1715 VdbeCoverage(v);
1716 }
1717 jmp6 = sqlite3VdbeAddOp1(v, OP_Next, iIdxCur+j); VdbeCoverage(v);
1718 sqlite3VdbeGoto(v, uniqOk);
1719 sqlite3VdbeJumpHere(v, jmp6);
1720 sqlite3VdbeAddOp4Int(v, OP_IdxGT, iIdxCur+j, uniqOk, r1,
1721 pIdx->nKeyCol); VdbeCoverage(v);
1722 sqlite3VdbeLoadString(v, 3, "non-unique entry in index ");
1723 sqlite3VdbeGoto(v, jmp5);
1724 sqlite3VdbeResolveLabel(v, uniqOk);
drhcefc87f2014-08-01 01:40:33 +00001725 }
drh226cef42017-09-09 20:38:49 +00001726 sqlite3VdbeJumpHere(v, jmp4);
1727 sqlite3ResolvePartIdxLabel(pParse, jmp3);
drhcefc87f2014-08-01 01:40:33 +00001728 }
drhed717fe2003-06-15 23:42:24 +00001729 }
drh688852a2014-02-17 22:40:43 +00001730 sqlite3VdbeAddOp2(v, OP_Next, iDataCur, loopTop); VdbeCoverage(v);
drh8a9789b2013-08-01 03:36:59 +00001731 sqlite3VdbeJumpHere(v, loopTop-1);
1732#ifndef SQLITE_OMIT_BTREECOUNT
drh8b174f22017-02-22 15:11:36 +00001733 if( !isQuick ){
1734 sqlite3VdbeLoadString(v, 2, "wrong # of entries in index ");
1735 for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
1736 if( pPk==pIdx ) continue;
drh8b174f22017-02-22 15:11:36 +00001737 sqlite3VdbeAddOp2(v, OP_Count, iIdxCur+j, 3);
drh66accfc2017-02-22 18:04:42 +00001738 addr = sqlite3VdbeAddOp3(v, OP_Eq, 8+j, 0, 3); VdbeCoverage(v);
drh8b174f22017-02-22 15:11:36 +00001739 sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
drh9ecd7082017-09-10 01:06:05 +00001740 sqlite3VdbeLoadString(v, 4, pIdx->zName);
1741 sqlite3VdbeAddOp3(v, OP_Concat, 4, 2, 3);
1742 integrityCheckResultRow(v);
drh66accfc2017-02-22 18:04:42 +00001743 sqlite3VdbeJumpHere(v, addr);
drh8b174f22017-02-22 15:11:36 +00001744 }
drhed717fe2003-06-15 23:42:24 +00001745 }
drh8a9789b2013-08-01 03:36:59 +00001746#endif /* SQLITE_OMIT_BTREECOUNT */
drhed717fe2003-06-15 23:42:24 +00001747 }
1748 }
drh2ce18652016-01-16 20:50:21 +00001749 {
1750 static const int iLn = VDBE_OFFSET_LINENO(2);
1751 static const VdbeOpList endCode[] = {
1752 { OP_AddImm, 1, 0, 0}, /* 0 */
drh66accfc2017-02-22 18:04:42 +00001753 { OP_IfNotZero, 1, 4, 0}, /* 1 */
drh2ce18652016-01-16 20:50:21 +00001754 { OP_String8, 0, 3, 0}, /* 2 */
drh1b325542016-02-03 01:55:44 +00001755 { OP_ResultRow, 3, 1, 0}, /* 3 */
drh74588ce2017-09-13 00:13:05 +00001756 { OP_Halt, 0, 0, 0}, /* 4 */
1757 { OP_String8, 0, 3, 0}, /* 5 */
1758 { OP_Goto, 0, 3, 0}, /* 6 */
drh2ce18652016-01-16 20:50:21 +00001759 };
1760 VdbeOp *aOp;
1761
1762 aOp = sqlite3VdbeAddOpList(v, ArraySize(endCode), endCode, iLn);
1763 if( aOp ){
drh66accfc2017-02-22 18:04:42 +00001764 aOp[0].p2 = 1-mxErr;
drh2ce18652016-01-16 20:50:21 +00001765 aOp[2].p4type = P4_STATIC;
1766 aOp[2].p4.z = "ok";
drh74588ce2017-09-13 00:13:05 +00001767 aOp[5].p4type = P4_STATIC;
1768 aOp[5].p4.z = (char*)sqlite3ErrStr(SQLITE_CORRUPT);
drh2ce18652016-01-16 20:50:21 +00001769 }
drh74588ce2017-09-13 00:13:05 +00001770 sqlite3VdbeChangeP3(v, 0, sqlite3VdbeCurrentAddr(v)-2);
drh2ce18652016-01-16 20:50:21 +00001771 }
drh9ccd8652013-09-13 16:36:46 +00001772 }
1773 break;
drhb7f91642004-10-31 02:22:47 +00001774#endif /* SQLITE_OMIT_INTEGRITY_CHECK */
1775
drh13d70422004-11-13 15:59:14 +00001776#ifndef SQLITE_OMIT_UTF16
danielk19778e227872004-06-07 07:52:17 +00001777 /*
1778 ** PRAGMA encoding
1779 ** PRAGMA encoding = "utf-8"|"utf-16"|"utf-16le"|"utf-16be"
1780 **
drh85b623f2007-12-13 21:54:09 +00001781 ** In its first form, this pragma returns the encoding of the main
danielk19778e227872004-06-07 07:52:17 +00001782 ** database. If the database is not initialized, it is initialized now.
1783 **
1784 ** The second form of this pragma is a no-op if the main database file
1785 ** has not already been initialized. In this case it sets the default
1786 ** encoding that will be used for the main database file if a new file
1787 ** is created. If an existing main database file is opened, then the
1788 ** default text encoding for the existing database is used.
1789 **
1790 ** In all cases new databases created using the ATTACH command are
1791 ** created to use the same default text encoding as the main database. If
1792 ** the main database has not been initialized and/or created when ATTACH
1793 ** is executed, this is done before the ATTACH operation.
1794 **
1795 ** In the second form this pragma sets the text encoding to be used in
1796 ** new database files created using this database handle. It is only
1797 ** useful if invoked immediately after the main database i
1798 */
drh9ccd8652013-09-13 16:36:46 +00001799 case PragTyp_ENCODING: {
drh0f7eb612006-08-08 13:51:43 +00001800 static const struct EncName {
danielk19778e227872004-06-07 07:52:17 +00001801 char *zName;
1802 u8 enc;
1803 } encnames[] = {
drh998da3a2004-06-19 15:22:56 +00001804 { "UTF8", SQLITE_UTF8 },
drhd2cb50b2009-01-09 21:41:17 +00001805 { "UTF-8", SQLITE_UTF8 }, /* Must be element [1] */
1806 { "UTF-16le", SQLITE_UTF16LE }, /* Must be element [2] */
1807 { "UTF-16be", SQLITE_UTF16BE }, /* Must be element [3] */
drh998da3a2004-06-19 15:22:56 +00001808 { "UTF16le", SQLITE_UTF16LE },
drh998da3a2004-06-19 15:22:56 +00001809 { "UTF16be", SQLITE_UTF16BE },
drh0f7eb612006-08-08 13:51:43 +00001810 { "UTF-16", 0 }, /* SQLITE_UTF16NATIVE */
1811 { "UTF16", 0 }, /* SQLITE_UTF16NATIVE */
danielk19778e227872004-06-07 07:52:17 +00001812 { 0, 0 }
1813 };
drh0f7eb612006-08-08 13:51:43 +00001814 const struct EncName *pEnc;
danielk197791cf71b2004-06-26 06:37:06 +00001815 if( !zRight ){ /* "PRAGMA encoding" */
danielk19778a414492004-06-29 08:59:35 +00001816 if( sqlite3ReadSchema(pParse) ) goto pragma_out;
drhd2cb50b2009-01-09 21:41:17 +00001817 assert( encnames[SQLITE_UTF8].enc==SQLITE_UTF8 );
1818 assert( encnames[SQLITE_UTF16LE].enc==SQLITE_UTF16LE );
1819 assert( encnames[SQLITE_UTF16BE].enc==SQLITE_UTF16BE );
drhc232aca2016-12-15 16:01:17 +00001820 returnSingleText(v, encnames[ENC(pParse->db)].zName);
danielk19778e227872004-06-07 07:52:17 +00001821 }else{ /* "PRAGMA encoding = XXX" */
1822 /* Only change the value of sqlite.enc if the database handle is not
1823 ** initialized. If the main database exists, the new sqlite.enc value
1824 ** will be overwritten when the schema is next loaded. If it does not
1825 ** already exists, it will be created to use the new encoding value.
1826 */
drhb5f0e402020-01-15 16:20:16 +00001827 int canChangeEnc = 1; /* True if allowed to change the encoding */
1828 int i; /* For looping over all attached databases */
1829 for(i=0; i<db->nDb; i++){
1830 if( db->aDb[i].pBt!=0
1831 && DbHasProperty(db,i,DB_SchemaLoaded)
1832 && !DbHasProperty(db,i,DB_Empty)
1833 ){
1834 canChangeEnc = 0;
1835 }
1836 }
1837 if( canChangeEnc ){
danielk19778e227872004-06-07 07:52:17 +00001838 for(pEnc=&encnames[0]; pEnc->zName; pEnc++){
1839 if( 0==sqlite3StrICmp(zRight, pEnc->zName) ){
drh42a630b2020-03-05 16:13:24 +00001840 u8 enc = pEnc->enc ? pEnc->enc : SQLITE_UTF16NATIVE;
1841 SCHEMA_ENC(db) = enc;
1842 sqlite3SetTextEncoding(db, enc);
danielk19778e227872004-06-07 07:52:17 +00001843 break;
1844 }
1845 }
1846 if( !pEnc->zName ){
drh5260f7e2004-06-26 19:35:29 +00001847 sqlite3ErrorMsg(pParse, "unsupported encoding: %s", zRight);
danielk19778e227872004-06-07 07:52:17 +00001848 }
1849 }
1850 }
drh9ccd8652013-09-13 16:36:46 +00001851 }
1852 break;
drh13d70422004-11-13 15:59:14 +00001853#endif /* SQLITE_OMIT_UTF16 */
1854
1855#ifndef SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
danielk1977dae24952004-11-11 05:10:43 +00001856 /*
drh9b0cf342015-11-12 14:57:19 +00001857 ** PRAGMA [schema.]schema_version
1858 ** PRAGMA [schema.]schema_version = <integer>
danielk1977dae24952004-11-11 05:10:43 +00001859 **
drh9b0cf342015-11-12 14:57:19 +00001860 ** PRAGMA [schema.]user_version
1861 ** PRAGMA [schema.]user_version = <integer>
danielk1977dae24952004-11-11 05:10:43 +00001862 **
drhe459bd42016-03-16 20:05:57 +00001863 ** PRAGMA [schema.]freelist_count
1864 **
1865 ** PRAGMA [schema.]data_version
drh4ee09b42013-05-01 19:49:27 +00001866 **
drh9b0cf342015-11-12 14:57:19 +00001867 ** PRAGMA [schema.]application_id
1868 ** PRAGMA [schema.]application_id = <integer>
drh4ee09b42013-05-01 19:49:27 +00001869 **
danielk1977b92b70b2004-11-12 16:11:59 +00001870 ** The pragma's schema_version and user_version are used to set or get
1871 ** the value of the schema-version and user-version, respectively. Both
1872 ** the schema-version and the user-version are 32-bit signed integers
danielk1977dae24952004-11-11 05:10:43 +00001873 ** stored in the database header.
1874 **
1875 ** The schema-cookie is usually only manipulated internally by SQLite. It
1876 ** is incremented by SQLite whenever the database schema is modified (by
danielk1977b92b70b2004-11-12 16:11:59 +00001877 ** creating or dropping a table or index). The schema version is used by
danielk1977dae24952004-11-11 05:10:43 +00001878 ** SQLite each time a query is executed to ensure that the internal cache
1879 ** of the schema used when compiling the SQL query matches the schema of
1880 ** the database against which the compiled query is actually executed.
danielk1977b92b70b2004-11-12 16:11:59 +00001881 ** Subverting this mechanism by using "PRAGMA schema_version" to modify
1882 ** the schema-version is potentially dangerous and may lead to program
danielk1977dae24952004-11-11 05:10:43 +00001883 ** crashes or database corruption. Use with caution!
1884 **
danielk1977b92b70b2004-11-12 16:11:59 +00001885 ** The user-version is not used internally by SQLite. It may be used by
danielk1977dae24952004-11-11 05:10:43 +00001886 ** applications for any purpose.
1887 */
drh9ccd8652013-09-13 16:36:46 +00001888 case PragTyp_HEADER_VALUE: {
drhc228be52015-01-31 02:00:01 +00001889 int iCookie = pPragma->iArg; /* Which cookie to read or write */
drhfb982642007-08-30 01:19:59 +00001890 sqlite3VdbeUsesBtree(v, iDb);
drhc232aca2016-12-15 16:01:17 +00001891 if( zRight && (pPragma->mPragFlg & PragFlg_ReadOnly)==0 ){
danielk1977dae24952004-11-11 05:10:43 +00001892 /* Write the specified cookie value */
1893 static const VdbeOpList setCookie[] = {
1894 { OP_Transaction, 0, 1, 0}, /* 0 */
drh1861afc2016-02-01 21:48:34 +00001895 { OP_SetCookie, 0, 0, 0}, /* 1 */
danielk1977dae24952004-11-11 05:10:43 +00001896 };
drh2ce18652016-01-16 20:50:21 +00001897 VdbeOp *aOp;
drhdad300d2016-01-18 00:20:26 +00001898 sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setCookie));
drh2ce18652016-01-16 20:50:21 +00001899 aOp = sqlite3VdbeAddOpList(v, ArraySize(setCookie), setCookie, 0);
drhdad300d2016-01-18 00:20:26 +00001900 if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
drh2ce18652016-01-16 20:50:21 +00001901 aOp[0].p1 = iDb;
drh1861afc2016-02-01 21:48:34 +00001902 aOp[1].p1 = iDb;
1903 aOp[1].p2 = iCookie;
1904 aOp[1].p3 = sqlite3Atoi(zRight);
danielk1977dae24952004-11-11 05:10:43 +00001905 }else{
1906 /* Read the specified cookie value */
1907 static const VdbeOpList readCookie[] = {
danielk1977602b4662009-07-02 07:47:33 +00001908 { OP_Transaction, 0, 0, 0}, /* 0 */
1909 { OP_ReadCookie, 0, 1, 0}, /* 1 */
drh2d401ab2008-01-10 23:50:11 +00001910 { OP_ResultRow, 1, 1, 0}
danielk1977dae24952004-11-11 05:10:43 +00001911 };
drh2ce18652016-01-16 20:50:21 +00001912 VdbeOp *aOp;
drhdad300d2016-01-18 00:20:26 +00001913 sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(readCookie));
drh2ce18652016-01-16 20:50:21 +00001914 aOp = sqlite3VdbeAddOpList(v, ArraySize(readCookie),readCookie,0);
drhdad300d2016-01-18 00:20:26 +00001915 if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
drh2ce18652016-01-16 20:50:21 +00001916 aOp[0].p1 = iDb;
1917 aOp[1].p1 = iDb;
1918 aOp[1].p3 = iCookie;
drhf71a3662016-03-16 20:44:45 +00001919 sqlite3VdbeReusable(v);
danielk1977dae24952004-11-11 05:10:43 +00001920 }
drh9ccd8652013-09-13 16:36:46 +00001921 }
1922 break;
drh13d70422004-11-13 15:59:14 +00001923#endif /* SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS */
drhc11d4f92003-04-06 21:08:24 +00001924
shanehdc97a8c2010-02-23 20:08:35 +00001925#ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
1926 /*
1927 ** PRAGMA compile_options
shanehdc97a8c2010-02-23 20:08:35 +00001928 **
drh71caabf2010-02-26 15:39:24 +00001929 ** Return the names of all compile-time options used in this build,
1930 ** one option per row.
shanehdc97a8c2010-02-23 20:08:35 +00001931 */
drh9ccd8652013-09-13 16:36:46 +00001932 case PragTyp_COMPILE_OPTIONS: {
shanehdc97a8c2010-02-23 20:08:35 +00001933 int i = 0;
1934 const char *zOpt;
shanehdc97a8c2010-02-23 20:08:35 +00001935 pParse->nMem = 1;
shanehdc97a8c2010-02-23 20:08:35 +00001936 while( (zOpt = sqlite3_compileoption_get(i++))!=0 ){
drh076e85f2015-09-03 13:46:12 +00001937 sqlite3VdbeLoadString(v, 1, zOpt);
shanehdc97a8c2010-02-23 20:08:35 +00001938 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
1939 }
drhf71a3662016-03-16 20:44:45 +00001940 sqlite3VdbeReusable(v);
drh9ccd8652013-09-13 16:36:46 +00001941 }
1942 break;
shanehdc97a8c2010-02-23 20:08:35 +00001943#endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
1944
dan5cf53532010-05-01 16:40:20 +00001945#ifndef SQLITE_OMIT_WAL
1946 /*
drh9b0cf342015-11-12 14:57:19 +00001947 ** PRAGMA [schema.]wal_checkpoint = passive|full|restart|truncate
dan5cf53532010-05-01 16:40:20 +00001948 **
1949 ** Checkpoint the database.
1950 */
drh9ccd8652013-09-13 16:36:46 +00001951 case PragTyp_WAL_CHECKPOINT: {
dana58f26f2010-11-16 18:56:51 +00001952 int iBt = (pId2->z?iDb:SQLITE_MAX_ATTACHED);
dancdc1f042010-11-18 12:11:05 +00001953 int eMode = SQLITE_CHECKPOINT_PASSIVE;
1954 if( zRight ){
1955 if( sqlite3StrICmp(zRight, "full")==0 ){
1956 eMode = SQLITE_CHECKPOINT_FULL;
1957 }else if( sqlite3StrICmp(zRight, "restart")==0 ){
1958 eMode = SQLITE_CHECKPOINT_RESTART;
danf26a1542014-12-02 19:04:54 +00001959 }else if( sqlite3StrICmp(zRight, "truncate")==0 ){
1960 eMode = SQLITE_CHECKPOINT_TRUNCATE;
dancdc1f042010-11-18 12:11:05 +00001961 }
1962 }
dancdc1f042010-11-18 12:11:05 +00001963 pParse->nMem = 3;
drh30aa3b92011-02-07 23:56:01 +00001964 sqlite3VdbeAddOp3(v, OP_Checkpoint, iBt, eMode, 1);
dancdc1f042010-11-18 12:11:05 +00001965 sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
drh9ccd8652013-09-13 16:36:46 +00001966 }
1967 break;
dan5a299f92010-05-03 11:05:08 +00001968
1969 /*
1970 ** PRAGMA wal_autocheckpoint
1971 ** PRAGMA wal_autocheckpoint = N
1972 **
1973 ** Configure a database connection to automatically checkpoint a database
1974 ** after accumulating N frames in the log. Or query for the current value
1975 ** of N.
1976 */
drh9ccd8652013-09-13 16:36:46 +00001977 case PragTyp_WAL_AUTOCHECKPOINT: {
dan5a299f92010-05-03 11:05:08 +00001978 if( zRight ){
drh60ac3f42010-11-23 18:59:27 +00001979 sqlite3_wal_autocheckpoint(db, sqlite3Atoi(zRight));
dan5a299f92010-05-03 11:05:08 +00001980 }
drhc232aca2016-12-15 16:01:17 +00001981 returnSingleInt(v,
drhb033d8b2010-05-03 13:37:30 +00001982 db->xWalCallback==sqlite3WalDefaultHook ?
1983 SQLITE_PTR_TO_INT(db->pWalArg) : 0);
drh9ccd8652013-09-13 16:36:46 +00001984 }
1985 break;
dan5cf53532010-05-01 16:40:20 +00001986#endif
dan7c246102010-04-12 19:00:29 +00001987
drh09419b42011-11-16 19:29:17 +00001988 /*
1989 ** PRAGMA shrink_memory
1990 **
drh51a74d42015-02-28 01:04:27 +00001991 ** IMPLEMENTATION-OF: R-23445-46109 This pragma causes the database
1992 ** connection on which it is invoked to free up as much memory as it
1993 ** can, by calling sqlite3_db_release_memory().
drh09419b42011-11-16 19:29:17 +00001994 */
drh9ccd8652013-09-13 16:36:46 +00001995 case PragTyp_SHRINK_MEMORY: {
drh09419b42011-11-16 19:29:17 +00001996 sqlite3_db_release_memory(db);
drh9ccd8652013-09-13 16:36:46 +00001997 break;
1998 }
drh09419b42011-11-16 19:29:17 +00001999
drhf3603962012-09-07 16:46:59 +00002000 /*
drh2ead47c2017-02-22 20:24:10 +00002001 ** PRAGMA optimize
drh1cfaf8e2017-03-02 14:17:21 +00002002 ** PRAGMA optimize(MASK)
drh2ead47c2017-02-22 20:24:10 +00002003 ** PRAGMA schema.optimize
drh1cfaf8e2017-03-02 14:17:21 +00002004 ** PRAGMA schema.optimize(MASK)
drh99d5b4c2017-02-18 22:52:40 +00002005 **
drh2ead47c2017-02-22 20:24:10 +00002006 ** Attempt to optimize the database. All schemas are optimized in the first
drh1cfaf8e2017-03-02 14:17:21 +00002007 ** two forms, and only the specified schema is optimized in the latter two.
drh2ead47c2017-02-22 20:24:10 +00002008 **
drhe1f1c082017-03-06 20:44:13 +00002009 ** The details of optimizations performed by this pragma are expected
drh2ead47c2017-02-22 20:24:10 +00002010 ** to change and improve over time. Applications should anticipate that
2011 ** this pragma will perform new optimizations in future releases.
2012 **
drh1cfaf8e2017-03-02 14:17:21 +00002013 ** The optional argument is a bitmask of optimizations to perform:
drh2ead47c2017-02-22 20:24:10 +00002014 **
drh1cfaf8e2017-03-02 14:17:21 +00002015 ** 0x0001 Debugging mode. Do not actually perform any optimizations
2016 ** but instead return one line of text for each optimization
2017 ** that would have been done. Off by default.
drh99d5b4c2017-02-18 22:52:40 +00002018 **
drh1cfaf8e2017-03-02 14:17:21 +00002019 ** 0x0002 Run ANALYZE on tables that might benefit. On by default.
2020 ** See below for additional information.
2021 **
2022 ** 0x0004 (Not yet implemented) Record usage and performance
2023 ** information from the current session in the
2024 ** database file so that it will be available to "optimize"
2025 ** pragmas run by future database connections.
2026 **
2027 ** 0x0008 (Not yet implemented) Create indexes that might have
2028 ** been helpful to recent queries
2029 **
drhe7c6f972017-07-15 20:25:22 +00002030 ** The default MASK is and always shall be 0xfffe. 0xfffe means perform all
2031 ** of the optimizations listed above except Debug Mode, including new
drh59dbe3a2017-03-06 23:51:16 +00002032 ** optimizations that have not yet been invented. If new optimizations are
2033 ** ever added that should be off by default, those off-by-default
2034 ** optimizations will have bitmasks of 0x10000 or larger.
drh1cfaf8e2017-03-02 14:17:21 +00002035 **
2036 ** DETERMINATION OF WHEN TO RUN ANALYZE
2037 **
2038 ** In the current implementation, a table is analyzed if only if all of
drh2ead47c2017-02-22 20:24:10 +00002039 ** the following are true:
drh99d5b4c2017-02-18 22:52:40 +00002040 **
drh1cfaf8e2017-03-02 14:17:21 +00002041 ** (1) MASK bit 0x02 is set.
2042 **
2043 ** (2) The query planner used sqlite_stat1-style statistics for one or
drh99d5b4c2017-02-18 22:52:40 +00002044 ** more indexes of the table at some point during the lifetime of
2045 ** the current connection.
2046 **
drh1cfaf8e2017-03-02 14:17:21 +00002047 ** (3) One or more indexes of the table are currently unanalyzed OR
drh99d5b4c2017-02-18 22:52:40 +00002048 ** the number of rows in the table has increased by 25 times or more
2049 ** since the last time ANALYZE was run.
drh2ead47c2017-02-22 20:24:10 +00002050 **
2051 ** The rules for when tables are analyzed are likely to change in
2052 ** future releases.
drh72052a72017-02-17 16:26:34 +00002053 */
drh2ead47c2017-02-22 20:24:10 +00002054 case PragTyp_OPTIMIZE: {
drh99d5b4c2017-02-18 22:52:40 +00002055 int iDbLast; /* Loop termination point for the schema loop */
2056 int iTabCur; /* Cursor for a table whose size needs checking */
2057 HashElem *k; /* Loop over tables of a schema */
2058 Schema *pSchema; /* The current schema */
2059 Table *pTab; /* A table in the schema */
2060 Index *pIdx; /* An index of the table */
2061 LogEst szThreshold; /* Size threshold above which reanalysis is needd */
2062 char *zSubSql; /* SQL statement for the OP_SqlExec opcode */
drh1cfaf8e2017-03-02 14:17:21 +00002063 u32 opMask; /* Mask of operations to perform */
drh4a54bb52017-02-18 15:58:52 +00002064
drh1cfaf8e2017-03-02 14:17:21 +00002065 if( zRight ){
2066 opMask = (u32)sqlite3Atoi(zRight);
2067 if( (opMask & 0x02)==0 ) break;
2068 }else{
drh59dbe3a2017-03-06 23:51:16 +00002069 opMask = 0xfffe;
drh1cfaf8e2017-03-02 14:17:21 +00002070 }
drh4a54bb52017-02-18 15:58:52 +00002071 iTabCur = pParse->nTab++;
2072 for(iDbLast = zDb?iDb:db->nDb-1; iDb<=iDbLast; iDb++){
2073 if( iDb==1 ) continue;
2074 sqlite3CodeVerifySchema(pParse, iDb);
2075 pSchema = db->aDb[iDb].pSchema;
2076 for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
2077 pTab = (Table*)sqliteHashData(k);
drh99d5b4c2017-02-18 22:52:40 +00002078
2079 /* If table pTab has not been used in a way that would benefit from
2080 ** having analysis statistics during the current session, then skip it.
2081 ** This also has the effect of skipping virtual tables and views */
drh4a54bb52017-02-18 15:58:52 +00002082 if( (pTab->tabFlags & TF_StatsUsed)==0 ) continue;
drh99d5b4c2017-02-18 22:52:40 +00002083
2084 /* Reanalyze if the table is 25 times larger than the last analysis */
drh4a54bb52017-02-18 15:58:52 +00002085 szThreshold = pTab->nRowLogEst + 46; assert( sqlite3LogEst(25)==46 );
2086 for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
2087 if( !pIdx->hasStat1 ){
drh99d5b4c2017-02-18 22:52:40 +00002088 szThreshold = 0; /* Always analyze if any index lacks statistics */
drh4a54bb52017-02-18 15:58:52 +00002089 break;
2090 }
2091 }
2092 if( szThreshold ){
2093 sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
2094 sqlite3VdbeAddOp3(v, OP_IfSmaller, iTabCur,
drh1cfaf8e2017-03-02 14:17:21 +00002095 sqlite3VdbeCurrentAddr(v)+2+(opMask&1), szThreshold);
drh4a54bb52017-02-18 15:58:52 +00002096 VdbeCoverage(v);
2097 }
2098 zSubSql = sqlite3MPrintf(db, "ANALYZE \"%w\".\"%w\"",
2099 db->aDb[iDb].zDbSName, pTab->zName);
drh1cfaf8e2017-03-02 14:17:21 +00002100 if( opMask & 0x01 ){
2101 int r1 = sqlite3GetTempReg(pParse);
2102 sqlite3VdbeAddOp4(v, OP_String8, 0, r1, 0, zSubSql, P4_DYNAMIC);
2103 sqlite3VdbeAddOp2(v, OP_ResultRow, r1, 1);
2104 }else{
2105 sqlite3VdbeAddOp4(v, OP_SqlExec, 0, 0, 0, zSubSql, P4_DYNAMIC);
2106 }
drh4a54bb52017-02-18 15:58:52 +00002107 }
2108 }
drhbce04142017-02-23 00:58:36 +00002109 sqlite3VdbeAddOp0(v, OP_Expire);
drh72052a72017-02-17 16:26:34 +00002110 break;
2111 }
2112
2113 /*
drhf3603962012-09-07 16:46:59 +00002114 ** PRAGMA busy_timeout
2115 ** PRAGMA busy_timeout = N
2116 **
2117 ** Call sqlite3_busy_timeout(db, N). Return the current timeout value
drhc0c7b5e2012-09-07 18:49:57 +00002118 ** if one is set. If no busy handler or a different busy handler is set
2119 ** then 0 is returned. Setting the busy_timeout to 0 or negative
2120 ** disables the timeout.
drhf3603962012-09-07 16:46:59 +00002121 */
drhd49c3582013-09-13 19:00:06 +00002122 /*case PragTyp_BUSY_TIMEOUT*/ default: {
drhc228be52015-01-31 02:00:01 +00002123 assert( pPragma->ePragTyp==PragTyp_BUSY_TIMEOUT );
drhf3603962012-09-07 16:46:59 +00002124 if( zRight ){
2125 sqlite3_busy_timeout(db, sqlite3Atoi(zRight));
2126 }
drhc232aca2016-12-15 16:01:17 +00002127 returnSingleInt(v, db->busyTimeout);
drh9ccd8652013-09-13 16:36:46 +00002128 break;
2129 }
drhf3603962012-09-07 16:46:59 +00002130
drh55e85ca2013-09-13 21:01:56 +00002131 /*
2132 ** PRAGMA soft_heap_limit
2133 ** PRAGMA soft_heap_limit = N
2134 **
drh51a74d42015-02-28 01:04:27 +00002135 ** IMPLEMENTATION-OF: R-26343-45930 This pragma invokes the
2136 ** sqlite3_soft_heap_limit64() interface with the argument N, if N is
2137 ** specified and is a non-negative integer.
2138 ** IMPLEMENTATION-OF: R-64451-07163 The soft_heap_limit pragma always
2139 ** returns the same integer that would be returned by the
2140 ** sqlite3_soft_heap_limit64(-1) C-language function.
drh55e85ca2013-09-13 21:01:56 +00002141 */
2142 case PragTyp_SOFT_HEAP_LIMIT: {
2143 sqlite3_int64 N;
drh9296c182014-07-23 13:40:49 +00002144 if( zRight && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK ){
drh55e85ca2013-09-13 21:01:56 +00002145 sqlite3_soft_heap_limit64(N);
2146 }
drhc232aca2016-12-15 16:01:17 +00002147 returnSingleInt(v, sqlite3_soft_heap_limit64(-1));
drh55e85ca2013-09-13 21:01:56 +00002148 break;
2149 }
2150
drh03459612014-08-25 15:13:22 +00002151 /*
drh10c0e712019-04-25 18:15:38 +00002152 ** PRAGMA hard_heap_limit
2153 ** PRAGMA hard_heap_limit = N
2154 **
2155 ** Invoke sqlite3_hard_heap_limit64() to query or set the hard heap
2156 ** limit. The hard heap limit can be activated or lowered by this
2157 ** pragma, but not raised or deactivated. Only the
2158 ** sqlite3_hard_heap_limit64() C-language API can raise or deactivate
2159 ** the hard heap limit. This allows an application to set a heap limit
2160 ** constraint that cannot be relaxed by an untrusted SQL script.
2161 */
2162 case PragTyp_HARD_HEAP_LIMIT: {
2163 sqlite3_int64 N;
2164 if( zRight && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK ){
2165 sqlite3_int64 iPrior = sqlite3_hard_heap_limit64(-1);
2166 if( N>0 && (iPrior==0 || iPrior>N) ) sqlite3_hard_heap_limit64(N);
2167 }
drh31999c52019-11-14 17:46:32 +00002168 returnSingleInt(v, sqlite3_hard_heap_limit64(-1));
drh10c0e712019-04-25 18:15:38 +00002169 break;
2170 }
2171
2172 /*
drh03459612014-08-25 15:13:22 +00002173 ** PRAGMA threads
2174 ** PRAGMA threads = N
2175 **
2176 ** Configure the maximum number of worker threads. Return the new
2177 ** maximum, which might be less than requested.
2178 */
2179 case PragTyp_THREADS: {
2180 sqlite3_int64 N;
drh111544c2014-08-29 16:20:47 +00002181 if( zRight
drh03459612014-08-25 15:13:22 +00002182 && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK
2183 && N>=0
2184 ){
drh111544c2014-08-29 16:20:47 +00002185 sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, (int)(N&0x7fffffff));
drh03459612014-08-25 15:13:22 +00002186 }
drhc232aca2016-12-15 16:01:17 +00002187 returnSingleInt(v, sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, -1));
drh03459612014-08-25 15:13:22 +00002188 break;
2189 }
2190
dougcurrie81c95ef2004-06-18 23:21:47 +00002191#if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
drh89ac8c12004-06-09 14:17:20 +00002192 /*
2193 ** Report the current state of file logs for all databases
2194 */
drh9ccd8652013-09-13 16:36:46 +00002195 case PragTyp_LOCK_STATUS: {
drh57196282004-10-06 15:41:16 +00002196 static const char *const azLockName[] = {
drh89ac8c12004-06-09 14:17:20 +00002197 "unlocked", "shared", "reserved", "pending", "exclusive"
2198 };
2199 int i;
drh2d401ab2008-01-10 23:50:11 +00002200 pParse->nMem = 2;
drh89ac8c12004-06-09 14:17:20 +00002201 for(i=0; i<db->nDb; i++){
2202 Btree *pBt;
drh9e33c2c2007-08-31 18:34:59 +00002203 const char *zState = "unknown";
2204 int j;
drh69c33822016-08-18 14:33:11 +00002205 if( db->aDb[i].zDbSName==0 ) continue;
drh89ac8c12004-06-09 14:17:20 +00002206 pBt = db->aDb[i].pBt;
drh5a05be12012-10-09 18:51:44 +00002207 if( pBt==0 || sqlite3BtreePager(pBt)==0 ){
drh9e33c2c2007-08-31 18:34:59 +00002208 zState = "closed";
drh69c33822016-08-18 14:33:11 +00002209 }else if( sqlite3_file_control(db, i ? db->aDb[i].zDbSName : 0,
drh9e33c2c2007-08-31 18:34:59 +00002210 SQLITE_FCNTL_LOCKSTATE, &j)==SQLITE_OK ){
2211 zState = azLockName[j];
drh89ac8c12004-06-09 14:17:20 +00002212 }
drh69c33822016-08-18 14:33:11 +00002213 sqlite3VdbeMultiLoad(v, 1, "ss", db->aDb[i].zDbSName, zState);
drh89ac8c12004-06-09 14:17:20 +00002214 }
drh9ccd8652013-09-13 16:36:46 +00002215 break;
2216 }
drh89ac8c12004-06-09 14:17:20 +00002217#endif
2218
drhb48c0d52020-02-07 01:12:53 +00002219#if defined(SQLITE_ENABLE_CEROD)
drh9ccd8652013-09-13 16:36:46 +00002220 case PragTyp_ACTIVATE_EXTENSIONS: if( zRight ){
drh21e2cab2006-09-25 18:01:57 +00002221 if( sqlite3StrNICmp(zRight, "cerod-", 6)==0 ){
drh21e2cab2006-09-25 18:01:57 +00002222 sqlite3_activate_cerod(&zRight[6]);
2223 }
drh9ccd8652013-09-13 16:36:46 +00002224 }
2225 break;
drh21e2cab2006-09-25 18:01:57 +00002226#endif
drh3c4f2a42005-12-08 18:12:56 +00002227
drh9ccd8652013-09-13 16:36:46 +00002228 } /* End of the PRAGMA switch */
danielk1977a21c6b62005-01-24 10:25:59 +00002229
dan9e1ab1a2017-01-05 19:32:48 +00002230 /* The following block is a no-op unless SQLITE_DEBUG is defined. Its only
2231 ** purpose is to execute assert() statements to verify that if the
2232 ** PragFlg_NoColumns1 flag is set and the caller specified an argument
2233 ** to the PRAGMA, the implementation has not added any OP_ResultRow
2234 ** instructions to the VM. */
2235 if( (pPragma->mPragFlg & PragFlg_NoColumns1) && zRight ){
2236 sqlite3VdbeVerifyNoResultRow(v);
2237 }
2238
danielk1977e0048402004-06-15 16:51:01 +00002239pragma_out:
drh633e6d52008-07-28 19:34:53 +00002240 sqlite3DbFree(db, zLeft);
2241 sqlite3DbFree(db, zRight);
drhc11d4f92003-04-06 21:08:24 +00002242}
drh2fcc1592016-12-15 20:59:03 +00002243#ifndef SQLITE_OMIT_VIRTUALTABLE
2244/*****************************************************************************
2245** Implementation of an eponymous virtual table that runs a pragma.
2246**
2247*/
2248typedef struct PragmaVtab PragmaVtab;
2249typedef struct PragmaVtabCursor PragmaVtabCursor;
2250struct PragmaVtab {
2251 sqlite3_vtab base; /* Base class. Must be first */
2252 sqlite3 *db; /* The database connection to which it belongs */
2253 const PragmaName *pName; /* Name of the pragma */
2254 u8 nHidden; /* Number of hidden columns */
2255 u8 iHidden; /* Index of the first hidden column */
2256};
2257struct PragmaVtabCursor {
2258 sqlite3_vtab_cursor base; /* Base class. Must be first */
2259 sqlite3_stmt *pPragma; /* The pragma statement to run */
2260 sqlite_int64 iRowid; /* Current rowid */
2261 char *azArg[2]; /* Value of the argument and schema */
2262};
2263
2264/*
2265** Pragma virtual table module xConnect method.
2266*/
2267static int pragmaVtabConnect(
2268 sqlite3 *db,
2269 void *pAux,
2270 int argc, const char *const*argv,
2271 sqlite3_vtab **ppVtab,
2272 char **pzErr
2273){
2274 const PragmaName *pPragma = (const PragmaName*)pAux;
2275 PragmaVtab *pTab = 0;
2276 int rc;
2277 int i, j;
2278 char cSep = '(';
2279 StrAccum acc;
2280 char zBuf[200];
2281
drh344a1bf2016-12-22 14:53:25 +00002282 UNUSED_PARAMETER(argc);
2283 UNUSED_PARAMETER(argv);
drh2fcc1592016-12-15 20:59:03 +00002284 sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
drh0cdbe1a2018-05-09 13:46:26 +00002285 sqlite3_str_appendall(&acc, "CREATE TABLE x");
drh2fcc1592016-12-15 20:59:03 +00002286 for(i=0, j=pPragma->iPragCName; i<pPragma->nPragCName; i++, j++){
drh0cdbe1a2018-05-09 13:46:26 +00002287 sqlite3_str_appendf(&acc, "%c\"%s\"", cSep, pragCName[j]);
drh2fcc1592016-12-15 20:59:03 +00002288 cSep = ',';
2289 }
drh9a63f092016-12-16 02:14:15 +00002290 if( i==0 ){
drh0cdbe1a2018-05-09 13:46:26 +00002291 sqlite3_str_appendf(&acc, "(\"%s\"", pPragma->zName);
drh9a63f092016-12-16 02:14:15 +00002292 i++;
2293 }
drh2fcc1592016-12-15 20:59:03 +00002294 j = 0;
2295 if( pPragma->mPragFlg & PragFlg_Result1 ){
drh0cdbe1a2018-05-09 13:46:26 +00002296 sqlite3_str_appendall(&acc, ",arg HIDDEN");
drh2fcc1592016-12-15 20:59:03 +00002297 j++;
2298 }
2299 if( pPragma->mPragFlg & (PragFlg_SchemaOpt|PragFlg_SchemaReq) ){
drh0cdbe1a2018-05-09 13:46:26 +00002300 sqlite3_str_appendall(&acc, ",schema HIDDEN");
drh2fcc1592016-12-15 20:59:03 +00002301 j++;
2302 }
drh0cdbe1a2018-05-09 13:46:26 +00002303 sqlite3_str_append(&acc, ")", 1);
drh2fcc1592016-12-15 20:59:03 +00002304 sqlite3StrAccumFinish(&acc);
2305 assert( strlen(zBuf) < sizeof(zBuf)-1 );
2306 rc = sqlite3_declare_vtab(db, zBuf);
2307 if( rc==SQLITE_OK ){
2308 pTab = (PragmaVtab*)sqlite3_malloc(sizeof(PragmaVtab));
2309 if( pTab==0 ){
2310 rc = SQLITE_NOMEM;
2311 }else{
2312 memset(pTab, 0, sizeof(PragmaVtab));
2313 pTab->pName = pPragma;
2314 pTab->db = db;
2315 pTab->iHidden = i;
2316 pTab->nHidden = j;
2317 }
2318 }else{
2319 *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
2320 }
2321
2322 *ppVtab = (sqlite3_vtab*)pTab;
2323 return rc;
2324}
2325
2326/*
2327** Pragma virtual table module xDisconnect method.
2328*/
2329static int pragmaVtabDisconnect(sqlite3_vtab *pVtab){
2330 PragmaVtab *pTab = (PragmaVtab*)pVtab;
2331 sqlite3_free(pTab);
2332 return SQLITE_OK;
2333}
2334
2335/* Figure out the best index to use to search a pragma virtual table.
2336**
2337** There are not really any index choices. But we want to encourage the
2338** query planner to give == constraints on as many hidden parameters as
2339** possible, and especially on the first hidden parameter. So return a
2340** high cost if hidden parameters are unconstrained.
2341*/
2342static int pragmaVtabBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
2343 PragmaVtab *pTab = (PragmaVtab*)tab;
2344 const struct sqlite3_index_constraint *pConstraint;
2345 int i, j;
2346 int seen[2];
2347
drhae7045c2016-12-15 21:33:55 +00002348 pIdxInfo->estimatedCost = (double)1;
drh2fcc1592016-12-15 20:59:03 +00002349 if( pTab->nHidden==0 ){ return SQLITE_OK; }
2350 pConstraint = pIdxInfo->aConstraint;
2351 seen[0] = 0;
2352 seen[1] = 0;
2353 for(i=0; i<pIdxInfo->nConstraint; i++, pConstraint++){
2354 if( pConstraint->usable==0 ) continue;
2355 if( pConstraint->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
2356 if( pConstraint->iColumn < pTab->iHidden ) continue;
2357 j = pConstraint->iColumn - pTab->iHidden;
2358 assert( j < 2 );
drhd7175eb2016-12-15 21:11:15 +00002359 seen[j] = i+1;
drh2fcc1592016-12-15 20:59:03 +00002360 }
2361 if( seen[0]==0 ){
2362 pIdxInfo->estimatedCost = (double)2147483647;
2363 pIdxInfo->estimatedRows = 2147483647;
2364 return SQLITE_OK;
2365 }
drhd7175eb2016-12-15 21:11:15 +00002366 j = seen[0]-1;
drh2fcc1592016-12-15 20:59:03 +00002367 pIdxInfo->aConstraintUsage[j].argvIndex = 1;
2368 pIdxInfo->aConstraintUsage[j].omit = 1;
2369 if( seen[1]==0 ) return SQLITE_OK;
2370 pIdxInfo->estimatedCost = (double)20;
2371 pIdxInfo->estimatedRows = 20;
drhd7175eb2016-12-15 21:11:15 +00002372 j = seen[1]-1;
drh2fcc1592016-12-15 20:59:03 +00002373 pIdxInfo->aConstraintUsage[j].argvIndex = 2;
2374 pIdxInfo->aConstraintUsage[j].omit = 1;
2375 return SQLITE_OK;
2376}
2377
2378/* Create a new cursor for the pragma virtual table */
2379static int pragmaVtabOpen(sqlite3_vtab *pVtab, sqlite3_vtab_cursor **ppCursor){
2380 PragmaVtabCursor *pCsr;
2381 pCsr = (PragmaVtabCursor*)sqlite3_malloc(sizeof(*pCsr));
2382 if( pCsr==0 ) return SQLITE_NOMEM;
2383 memset(pCsr, 0, sizeof(PragmaVtabCursor));
2384 pCsr->base.pVtab = pVtab;
2385 *ppCursor = &pCsr->base;
2386 return SQLITE_OK;
2387}
2388
2389/* Clear all content from pragma virtual table cursor. */
2390static void pragmaVtabCursorClear(PragmaVtabCursor *pCsr){
2391 int i;
2392 sqlite3_finalize(pCsr->pPragma);
2393 pCsr->pPragma = 0;
2394 for(i=0; i<ArraySize(pCsr->azArg); i++){
2395 sqlite3_free(pCsr->azArg[i]);
2396 pCsr->azArg[i] = 0;
2397 }
2398}
2399
2400/* Close a pragma virtual table cursor */
2401static int pragmaVtabClose(sqlite3_vtab_cursor *cur){
2402 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)cur;
2403 pragmaVtabCursorClear(pCsr);
drh9a63f092016-12-16 02:14:15 +00002404 sqlite3_free(pCsr);
drh2fcc1592016-12-15 20:59:03 +00002405 return SQLITE_OK;
2406}
2407
2408/* Advance the pragma virtual table cursor to the next row */
2409static int pragmaVtabNext(sqlite3_vtab_cursor *pVtabCursor){
2410 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2411 int rc = SQLITE_OK;
2412
2413 /* Increment the xRowid value */
2414 pCsr->iRowid++;
drh9a63f092016-12-16 02:14:15 +00002415 assert( pCsr->pPragma );
2416 if( SQLITE_ROW!=sqlite3_step(pCsr->pPragma) ){
2417 rc = sqlite3_finalize(pCsr->pPragma);
2418 pCsr->pPragma = 0;
2419 pragmaVtabCursorClear(pCsr);
drh2fcc1592016-12-15 20:59:03 +00002420 }
2421 return rc;
2422}
2423
2424/*
2425** Pragma virtual table module xFilter method.
2426*/
2427static int pragmaVtabFilter(
2428 sqlite3_vtab_cursor *pVtabCursor,
2429 int idxNum, const char *idxStr,
2430 int argc, sqlite3_value **argv
2431){
2432 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2433 PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
2434 int rc;
drhd8b72002016-12-16 04:20:27 +00002435 int i, j;
drh2fcc1592016-12-15 20:59:03 +00002436 StrAccum acc;
2437 char *zSql;
2438
drh344a1bf2016-12-22 14:53:25 +00002439 UNUSED_PARAMETER(idxNum);
2440 UNUSED_PARAMETER(idxStr);
drh2fcc1592016-12-15 20:59:03 +00002441 pragmaVtabCursorClear(pCsr);
drhd8b72002016-12-16 04:20:27 +00002442 j = (pTab->pName->mPragFlg & PragFlg_Result1)!=0 ? 0 : 1;
2443 for(i=0; i<argc; i++, j++){
dand8ecefa2017-07-15 20:48:30 +00002444 const char *zText = (const char*)sqlite3_value_text(argv[i]);
drhd8b72002016-12-16 04:20:27 +00002445 assert( j<ArraySize(pCsr->azArg) );
dand8ecefa2017-07-15 20:48:30 +00002446 assert( pCsr->azArg[j]==0 );
2447 if( zText ){
2448 pCsr->azArg[j] = sqlite3_mprintf("%s", zText);
2449 if( pCsr->azArg[j]==0 ){
2450 return SQLITE_NOMEM;
2451 }
drh2fcc1592016-12-15 20:59:03 +00002452 }
2453 }
drhd7175eb2016-12-15 21:11:15 +00002454 sqlite3StrAccumInit(&acc, 0, 0, 0, pTab->db->aLimit[SQLITE_LIMIT_SQL_LENGTH]);
drh0cdbe1a2018-05-09 13:46:26 +00002455 sqlite3_str_appendall(&acc, "PRAGMA ");
drh2fcc1592016-12-15 20:59:03 +00002456 if( pCsr->azArg[1] ){
drh0cdbe1a2018-05-09 13:46:26 +00002457 sqlite3_str_appendf(&acc, "%Q.", pCsr->azArg[1]);
drh2fcc1592016-12-15 20:59:03 +00002458 }
drh0cdbe1a2018-05-09 13:46:26 +00002459 sqlite3_str_appendall(&acc, pTab->pName->zName);
drh2fcc1592016-12-15 20:59:03 +00002460 if( pCsr->azArg[0] ){
drh0cdbe1a2018-05-09 13:46:26 +00002461 sqlite3_str_appendf(&acc, "=%Q", pCsr->azArg[0]);
drh2fcc1592016-12-15 20:59:03 +00002462 }
2463 zSql = sqlite3StrAccumFinish(&acc);
2464 if( zSql==0 ) return SQLITE_NOMEM;
2465 rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pCsr->pPragma, 0);
2466 sqlite3_free(zSql);
2467 if( rc!=SQLITE_OK ){
2468 pTab->base.zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(pTab->db));
2469 return rc;
2470 }
2471 return pragmaVtabNext(pVtabCursor);
2472}
2473
2474/*
2475** Pragma virtual table module xEof method.
2476*/
2477static int pragmaVtabEof(sqlite3_vtab_cursor *pVtabCursor){
2478 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2479 return (pCsr->pPragma==0);
2480}
2481
2482/* The xColumn method simply returns the corresponding column from
2483** the PRAGMA.
2484*/
2485static int pragmaVtabColumn(
2486 sqlite3_vtab_cursor *pVtabCursor,
2487 sqlite3_context *ctx,
2488 int i
2489){
2490 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2491 PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
2492 if( i<pTab->iHidden ){
2493 sqlite3_result_value(ctx, sqlite3_column_value(pCsr->pPragma, i));
2494 }else{
2495 sqlite3_result_text(ctx, pCsr->azArg[i-pTab->iHidden],-1,SQLITE_TRANSIENT);
2496 }
2497 return SQLITE_OK;
2498}
2499
2500/*
2501** Pragma virtual table module xRowid method.
2502*/
2503static int pragmaVtabRowid(sqlite3_vtab_cursor *pVtabCursor, sqlite_int64 *p){
2504 PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2505 *p = pCsr->iRowid;
2506 return SQLITE_OK;
2507}
2508
2509/* The pragma virtual table object */
2510static const sqlite3_module pragmaVtabModule = {
2511 0, /* iVersion */
2512 0, /* xCreate - create a table */
2513 pragmaVtabConnect, /* xConnect - connect to an existing table */
2514 pragmaVtabBestIndex, /* xBestIndex - Determine search strategy */
2515 pragmaVtabDisconnect, /* xDisconnect - Disconnect from a table */
2516 0, /* xDestroy - Drop a table */
2517 pragmaVtabOpen, /* xOpen - open a cursor */
2518 pragmaVtabClose, /* xClose - close a cursor */
2519 pragmaVtabFilter, /* xFilter - configure scan constraints */
2520 pragmaVtabNext, /* xNext - advance a cursor */
2521 pragmaVtabEof, /* xEof */
2522 pragmaVtabColumn, /* xColumn - read data */
2523 pragmaVtabRowid, /* xRowid - read data */
2524 0, /* xUpdate - write data */
2525 0, /* xBegin - begin transaction */
2526 0, /* xSync - sync transaction */
2527 0, /* xCommit - commit transaction */
2528 0, /* xRollback - rollback transaction */
2529 0, /* xFindFunction - function overloading */
2530 0, /* xRename - rename the table */
2531 0, /* xSavepoint */
2532 0, /* xRelease */
drh84c501b2018-11-05 23:01:45 +00002533 0, /* xRollbackTo */
2534 0 /* xShadowName */
drh2fcc1592016-12-15 20:59:03 +00002535};
2536
2537/*
2538** Check to see if zTabName is really the name of a pragma. If it is,
2539** then register an eponymous virtual table for that pragma and return
2540** a pointer to the Module object for the new virtual table.
2541*/
2542Module *sqlite3PragmaVtabRegister(sqlite3 *db, const char *zName){
2543 const PragmaName *pName;
2544 assert( sqlite3_strnicmp(zName, "pragma_", 7)==0 );
2545 pName = pragmaLocate(zName+7);
2546 if( pName==0 ) return 0;
2547 if( (pName->mPragFlg & (PragFlg_Result0|PragFlg_Result1))==0 ) return 0;
2548 assert( sqlite3HashFind(&db->aModule, zName)==0 );
drhd7175eb2016-12-15 21:11:15 +00002549 return sqlite3VtabCreateModule(db, zName, &pragmaVtabModule, (void*)pName, 0);
drh2fcc1592016-12-15 20:59:03 +00002550}
2551
2552#endif /* SQLITE_OMIT_VIRTUALTABLE */
drh13d70422004-11-13 15:59:14 +00002553
drh8bfdf722009-06-19 14:06:03 +00002554#endif /* SQLITE_OMIT_PRAGMA */