xref: /sqlite-3.40.0/src/pragma.c (revision 3b328522)
1 /*
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.
13 */
14 #include "sqliteInt.h"
15 
16 #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 /***************************************************************************
25 ** 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"
32 
33 /*
34 ** Interpret the given string as a safety level.  Return 0 for OFF,
35 ** 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
37 ** if the omitFull parameter it 1.
38 **
39 ** Note that the values returned are one less that the values that
40 ** should be passed into sqlite3BtreeSetSafetyLevel().  The is done
41 ** 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 */
44 static u8 getSafetyLevel(const char *z, int omitFull, u8 dflt){
45                              /* 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 */
51   int i, n;
52   if( sqlite3Isdigit(*z) ){
53     return (u8)sqlite3Atoi(z);
54   }
55   n = sqlite3Strlen30(z);
56   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     ){
60       return iValue[i];
61     }
62   }
63   return dflt;
64 }
65 
66 /*
67 ** Interpret the given string as a boolean value.
68 */
69 u8 sqlite3GetBoolean(const char *z, u8 dflt){
70   return getSafetyLevel(z,1,dflt)!=0;
71 }
72 
73 /* 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 
79 /*
80 ** Interpret the given string as a locking mode value.
81 */
82 static 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 
90 #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 */
97 static 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;
102   i = sqlite3Atoi(z);
103   return (u8)((i>=0&&i<=2)?i:0);
104 }
105 #endif /* ifndef SQLITE_OMIT_AUTOVACUUM */
106 
107 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
108 /*
109 ** 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 */
113 static 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 }
124 #endif /* SQLITE_PAGER_PRAGMAS */
125 
126 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
127 /*
128 ** Invalidate temp storage, either when the temp storage is changed
129 ** from default, or when 'file' and the temp_store_directory has changed
130 */
131 static int invalidateTempStorage(Parse *pParse){
132   sqlite3 *db = pParse->db;
133   if( db->aDb[1].pBt!=0 ){
134     if( !db->autoCommit || sqlite3BtreeIsInReadTrans(db->aDb[1].pBt) ){
135       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;
141     sqlite3ResetAllSchemasOfConnection(db);
142   }
143   return SQLITE_OK;
144 }
145 #endif /* SQLITE_PAGER_PRAGMAS */
146 
147 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
148 /*
149 ** If the TEMP database is open, close it and mark the database schema
150 ** as needing reloading.  This must be done when using the SQLITE_TEMP_STORE
151 ** or DEFAULT_TEMP_STORE pragmas.
152 */
153 static 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   }
160   db->temp_store = (u8)ts;
161   return SQLITE_OK;
162 }
163 #endif /* SQLITE_PAGER_PRAGMAS */
164 
165 /*
166 ** Set result column names for a pragma.
167 */
168 static void setPragmaResultColumnNames(
169   Vdbe *v,                     /* The query under construction */
170   const PragmaName *pPragma    /* The pragma */
171 ){
172   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     }
181   }
182 }
183 
184 /*
185 ** Generate code to return a single integer value.
186 */
187 static void returnSingleInt(Vdbe *v, i64 value){
188   sqlite3VdbeAddOp4Dup8(v, OP_Int64, 0, 1, 0, (const u8*)&value, P4_INT64);
189   sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
190 }
191 
192 /*
193 ** Generate code to return a single text value.
194 */
195 static void returnSingleText(
196   Vdbe *v,                /* Prepared statement under construction */
197   const char *zValue      /* Value to be returned */
198 ){
199   if( zValue ){
200     sqlite3VdbeLoadString(v, 1, (const char*)zValue);
201     sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
202   }
203 }
204 
205 
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
211 static 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 }
230 #else
231 # define setAllPagerFlags(X)  /* no-op */
232 #endif
233 
234 
235 /*
236 ** Return a human-readable name for a constraint resolution action.
237 */
238 #ifndef SQLITE_OMIT_FOREIGN_KEY
239 static const char *actionName(u8 action){
240   const char *zName;
241   switch( action ){
242     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;
248   }
249   return zName;
250 }
251 #endif
252 
253 
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 */
259 const char *sqlite3JournalModename(int eMode){
260   static char * const azModeName[] = {
261     "delete", "persist", "off", "truncate", "memory"
262 #ifndef SQLITE_OMIT_WAL
263      , "wal"
264 #endif
265   };
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 
278 /*
279 ** Locate a pragma in the aPragmaName[] array.
280 */
281 static const PragmaName *pragmaLocate(const char *zName){
282   int upr, lwr, mid = 0, rc;
283   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 /*
299 ** Helper subroutine for PRAGMA integrity_check:
300 **
301 ** Generate code to output a single-column result row with the result
302 ** held in register regResult.  Decrement the result count and halt if
303 ** the maximum number of result rows have been issued.
304 */
305 static int integrityCheckResultRow(Vdbe *v, int regResult){
306   int addr;
307   sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, 1);
308   addr = sqlite3VdbeAddOp3(v, OP_IfPos, 1, sqlite3VdbeCurrentAddr(v)+2, 1);
309   VdbeCoverage(v);
310   sqlite3VdbeAddOp2(v, OP_Halt, 0, 0);
311   return addr;
312 }
313 
314 /*
315 ** Process a pragma statement.
316 **
317 ** Pragmas are of this form:
318 **
319 **      PRAGMA [schema.]id [= value]
320 **
321 ** The identifier might also be a string.  The value is a string, and
322 ** identifier, or a number.  If minusFlag is true, then the value is
323 ** a number that was preceded by a minus sign.
324 **
325 ** If the left side is "database.id" then pId1 is the database name
326 ** and pId2 is the id.  If the left side is just "id" then pId1 is the
327 ** id and pId2 is any empty string.
328 */
329 void sqlite3Pragma(
330   Parse *pParse,
331   Token *pId1,        /* First part of [schema.]id field */
332   Token *pId2,        /* Second part of [schema.]id field, or NULL */
333   Token *pValue,      /* Token for <value>, or NULL */
334   int minusFlag       /* True if a '-' sign preceded <value> */
335 ){
336   char *zLeft = 0;       /* Nul-terminated UTF-8 string <id> */
337   char *zRight = 0;      /* Nul-terminated UTF-8 string <value>, or NULL */
338   const char *zDb = 0;   /* The database name */
339   Token *pId;            /* Pointer to <id> token */
340   char *aFcntl[4];       /* Argument to SQLITE_FCNTL_PRAGMA */
341   int iDb;               /* Database index for <database> */
342   int rc;                      /* return value form SQLITE_FCNTL_PRAGMA */
343   sqlite3 *db = pParse->db;    /* The database connection */
344   Db *pDb;                     /* The specific database being pragmaed */
345   Vdbe *v = sqlite3GetVdbe(pParse);  /* Prepared statement */
346   const PragmaName *pPragma;   /* The pragma */
347 
348   if( v==0 ) return;
349   sqlite3VdbeRunOnlyOnce(v);
350   pParse->nMem = 2;
351 
352   /* Interpret the [schema.] part of the pragma statement. iDb is the
353   ** index of the database this pragma is being applied to in db.aDb[]. */
354   iDb = sqlite3TwoPartName(pParse, pId1, pId2, &pId);
355   if( iDb<0 ) return;
356   pDb = &db->aDb[iDb];
357 
358   /* If the temp database has been explicitly named as part of the
359   ** pragma, make sure it is open.
360   */
361   if( iDb==1 && sqlite3OpenTempDatabase(pParse) ){
362     return;
363   }
364 
365   zLeft = sqlite3NameFromToken(db, pId);
366   if( !zLeft ) return;
367   if( minusFlag ){
368     zRight = sqlite3MPrintf(db, "-%T", pValue);
369   }else{
370     zRight = sqlite3NameFromToken(db, pValue);
371   }
372 
373   assert( pId2 );
374   zDb = pId2->n>0 ? pDb->zDbSName : 0;
375   if( sqlite3AuthCheck(pParse, SQLITE_PRAGMA, zLeft, zRight, zDb) ){
376     goto pragma_out;
377   }
378 
379   /* Send an SQLITE_FCNTL_PRAGMA file-control to the underlying VFS
380   ** connection.  If it returns SQLITE_OK, then assume that the VFS
381   ** handled the pragma and generate a no-op prepared statement.
382   **
383   ** IMPLEMENTATION-OF: R-12238-55120 Whenever a PRAGMA statement is parsed,
384   ** an SQLITE_FCNTL_PRAGMA file control is sent to the open sqlite3_file
385   ** object corresponding to the database file to which the pragma
386   ** statement refers.
387   **
388   ** IMPLEMENTATION-OF: R-29875-31678 The argument to the SQLITE_FCNTL_PRAGMA
389   ** file control is an array of pointers to strings (char**) in which the
390   ** second element of the array is the name of the pragma and the third
391   ** element is the argument to the pragma or NULL if the pragma has no
392   ** argument.
393   */
394   aFcntl[0] = 0;
395   aFcntl[1] = zLeft;
396   aFcntl[2] = zRight;
397   aFcntl[3] = 0;
398   db->busyHandler.nBusy = 0;
399   rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_PRAGMA, (void*)aFcntl);
400   if( rc==SQLITE_OK ){
401     sqlite3VdbeSetNumCols(v, 1);
402     sqlite3VdbeSetColName(v, 0, COLNAME_NAME, aFcntl[0], SQLITE_TRANSIENT);
403     returnSingleText(v, aFcntl[0]);
404     sqlite3_free(aFcntl[0]);
405     goto pragma_out;
406   }
407   if( rc!=SQLITE_NOTFOUND ){
408     if( aFcntl[0] ){
409       sqlite3ErrorMsg(pParse, "%s", aFcntl[0]);
410       sqlite3_free(aFcntl[0]);
411     }
412     pParse->nErr++;
413     pParse->rc = rc;
414     goto pragma_out;
415   }
416 
417   /* Locate the pragma in the lookup table */
418   pPragma = pragmaLocate(zLeft);
419   if( pPragma==0 ) goto pragma_out;
420 
421   /* Make sure the database schema is loaded if the pragma requires that */
422   if( (pPragma->mPragFlg & PragFlg_NeedSchema)!=0 ){
423     if( sqlite3ReadSchema(pParse) ) goto pragma_out;
424   }
425 
426   /* Register the result column names for pragmas that return results */
427   if( (pPragma->mPragFlg & PragFlg_NoColumns)==0
428    && ((pPragma->mPragFlg & PragFlg_NoColumns1)==0 || zRight==0)
429   ){
430     setPragmaResultColumnNames(v, pPragma);
431   }
432 
433   /* Jump to the appropriate pragma handler */
434   switch( pPragma->ePragTyp ){
435 
436 #if !defined(SQLITE_OMIT_PAGER_PRAGMAS) && !defined(SQLITE_OMIT_DEPRECATED)
437   /*
438   **  PRAGMA [schema.]default_cache_size
439   **  PRAGMA [schema.]default_cache_size=N
440   **
441   ** The first form reports the current persistent setting for the
442   ** page cache size.  The value returned is the maximum number of
443   ** pages in the page cache.  The second form sets both the current
444   ** page cache size value and the persistent page cache size value
445   ** stored in the database file.
446   **
447   ** Older versions of SQLite would set the default cache size to a
448   ** negative number to indicate synchronous=OFF.  These days, synchronous
449   ** is always on by default regardless of the sign of the default cache
450   ** size.  But continue to take the absolute value of the default cache
451   ** size of historical compatibility.
452   */
453   case PragTyp_DEFAULT_CACHE_SIZE: {
454     static const int iLn = VDBE_OFFSET_LINENO(2);
455     static const VdbeOpList getCacheSize[] = {
456       { OP_Transaction, 0, 0,        0},                         /* 0 */
457       { OP_ReadCookie,  0, 1,        BTREE_DEFAULT_CACHE_SIZE},  /* 1 */
458       { OP_IfPos,       1, 8,        0},
459       { OP_Integer,     0, 2,        0},
460       { OP_Subtract,    1, 2,        1},
461       { OP_IfPos,       1, 8,        0},
462       { OP_Integer,     0, 1,        0},                         /* 6 */
463       { OP_Noop,        0, 0,        0},
464       { OP_ResultRow,   1, 1,        0},
465     };
466     VdbeOp *aOp;
467     sqlite3VdbeUsesBtree(v, iDb);
468     if( !zRight ){
469       pParse->nMem += 2;
470       sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(getCacheSize));
471       aOp = sqlite3VdbeAddOpList(v, ArraySize(getCacheSize), getCacheSize, iLn);
472       if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
473       aOp[0].p1 = iDb;
474       aOp[1].p1 = iDb;
475       aOp[6].p1 = SQLITE_DEFAULT_CACHE_SIZE;
476     }else{
477       int size = sqlite3AbsInt32(sqlite3Atoi(zRight));
478       sqlite3BeginWriteOperation(pParse, 0, iDb);
479       sqlite3VdbeAddOp3(v, OP_SetCookie, iDb, BTREE_DEFAULT_CACHE_SIZE, size);
480       assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
481       pDb->pSchema->cache_size = size;
482       sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
483     }
484     break;
485   }
486 #endif /* !SQLITE_OMIT_PAGER_PRAGMAS && !SQLITE_OMIT_DEPRECATED */
487 
488 #if !defined(SQLITE_OMIT_PAGER_PRAGMAS)
489   /*
490   **  PRAGMA [schema.]page_size
491   **  PRAGMA [schema.]page_size=N
492   **
493   ** The first form reports the current setting for the
494   ** database page size in bytes.  The second form sets the
495   ** database page size value.  The value can only be set if
496   ** the database has not yet been created.
497   */
498   case PragTyp_PAGE_SIZE: {
499     Btree *pBt = pDb->pBt;
500     assert( pBt!=0 );
501     if( !zRight ){
502       int size = ALWAYS(pBt) ? sqlite3BtreeGetPageSize(pBt) : 0;
503       returnSingleInt(v, size);
504     }else{
505       /* Malloc may fail when setting the page-size, as there is an internal
506       ** buffer that the pager module resizes using sqlite3_realloc().
507       */
508       db->nextPagesize = sqlite3Atoi(zRight);
509       if( SQLITE_NOMEM==sqlite3BtreeSetPageSize(pBt, db->nextPagesize,-1,0) ){
510         sqlite3OomFault(db);
511       }
512     }
513     break;
514   }
515 
516   /*
517   **  PRAGMA [schema.]secure_delete
518   **  PRAGMA [schema.]secure_delete=ON/OFF
519   **
520   ** The first form reports the current setting for the
521   ** secure_delete flag.  The second form changes the secure_delete
522   ** flag setting and reports thenew value.
523   */
524   case PragTyp_SECURE_DELETE: {
525     Btree *pBt = pDb->pBt;
526     int b = -1;
527     assert( pBt!=0 );
528     if( zRight ){
529       b = sqlite3GetBoolean(zRight, 0);
530     }
531     if( pId2->n==0 && b>=0 ){
532       int ii;
533       for(ii=0; ii<db->nDb; ii++){
534         sqlite3BtreeSecureDelete(db->aDb[ii].pBt, b);
535       }
536     }
537     b = sqlite3BtreeSecureDelete(pBt, b);
538     returnSingleInt(v, b);
539     break;
540   }
541 
542   /*
543   **  PRAGMA [schema.]max_page_count
544   **  PRAGMA [schema.]max_page_count=N
545   **
546   ** The first form reports the current setting for the
547   ** maximum number of pages in the database file.  The
548   ** second form attempts to change this setting.  Both
549   ** forms return the current setting.
550   **
551   ** The absolute value of N is used.  This is undocumented and might
552   ** change.  The only purpose is to provide an easy way to test
553   ** the sqlite3AbsInt32() function.
554   **
555   **  PRAGMA [schema.]page_count
556   **
557   ** Return the number of pages in the specified database.
558   */
559   case PragTyp_PAGE_COUNT: {
560     int iReg;
561     sqlite3CodeVerifySchema(pParse, iDb);
562     iReg = ++pParse->nMem;
563     if( sqlite3Tolower(zLeft[0])=='p' ){
564       sqlite3VdbeAddOp2(v, OP_Pagecount, iDb, iReg);
565     }else{
566       sqlite3VdbeAddOp3(v, OP_MaxPgcnt, iDb, iReg,
567                         sqlite3AbsInt32(sqlite3Atoi(zRight)));
568     }
569     sqlite3VdbeAddOp2(v, OP_ResultRow, iReg, 1);
570     break;
571   }
572 
573   /*
574   **  PRAGMA [schema.]locking_mode
575   **  PRAGMA [schema.]locking_mode = (normal|exclusive)
576   */
577   case PragTyp_LOCKING_MODE: {
578     const char *zRet = "normal";
579     int eMode = getLockingMode(zRight);
580 
581     if( pId2->n==0 && eMode==PAGER_LOCKINGMODE_QUERY ){
582       /* Simple "PRAGMA locking_mode;" statement. This is a query for
583       ** the current default locking mode (which may be different to
584       ** the locking-mode of the main database).
585       */
586       eMode = db->dfltLockMode;
587     }else{
588       Pager *pPager;
589       if( pId2->n==0 ){
590         /* This indicates that no database name was specified as part
591         ** of the PRAGMA command. In this case the locking-mode must be
592         ** set on all attached databases, as well as the main db file.
593         **
594         ** Also, the sqlite3.dfltLockMode variable is set so that
595         ** any subsequently attached databases also use the specified
596         ** locking mode.
597         */
598         int ii;
599         assert(pDb==&db->aDb[0]);
600         for(ii=2; ii<db->nDb; ii++){
601           pPager = sqlite3BtreePager(db->aDb[ii].pBt);
602           sqlite3PagerLockingMode(pPager, eMode);
603         }
604         db->dfltLockMode = (u8)eMode;
605       }
606       pPager = sqlite3BtreePager(pDb->pBt);
607       eMode = sqlite3PagerLockingMode(pPager, eMode);
608     }
609 
610     assert( eMode==PAGER_LOCKINGMODE_NORMAL
611             || eMode==PAGER_LOCKINGMODE_EXCLUSIVE );
612     if( eMode==PAGER_LOCKINGMODE_EXCLUSIVE ){
613       zRet = "exclusive";
614     }
615     returnSingleText(v, zRet);
616     break;
617   }
618 
619   /*
620   **  PRAGMA [schema.]journal_mode
621   **  PRAGMA [schema.]journal_mode =
622   **                      (delete|persist|off|truncate|memory|wal|off)
623   */
624   case PragTyp_JOURNAL_MODE: {
625     int eMode;        /* One of the PAGER_JOURNALMODE_XXX symbols */
626     int ii;           /* Loop counter */
627 
628     if( zRight==0 ){
629       /* If there is no "=MODE" part of the pragma, do a query for the
630       ** current mode */
631       eMode = PAGER_JOURNALMODE_QUERY;
632     }else{
633       const char *zMode;
634       int n = sqlite3Strlen30(zRight);
635       for(eMode=0; (zMode = sqlite3JournalModename(eMode))!=0; eMode++){
636         if( sqlite3StrNICmp(zRight, zMode, n)==0 ) break;
637       }
638       if( !zMode ){
639         /* If the "=MODE" part does not match any known journal mode,
640         ** then do a query */
641         eMode = PAGER_JOURNALMODE_QUERY;
642       }
643     }
644     if( eMode==PAGER_JOURNALMODE_QUERY && pId2->n==0 ){
645       /* Convert "PRAGMA journal_mode" into "PRAGMA main.journal_mode" */
646       iDb = 0;
647       pId2->n = 1;
648     }
649     for(ii=db->nDb-1; ii>=0; ii--){
650       if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
651         sqlite3VdbeUsesBtree(v, ii);
652         sqlite3VdbeAddOp3(v, OP_JournalMode, ii, 1, eMode);
653       }
654     }
655     sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
656     break;
657   }
658 
659   /*
660   **  PRAGMA [schema.]journal_size_limit
661   **  PRAGMA [schema.]journal_size_limit=N
662   **
663   ** Get or set the size limit on rollback journal files.
664   */
665   case PragTyp_JOURNAL_SIZE_LIMIT: {
666     Pager *pPager = sqlite3BtreePager(pDb->pBt);
667     i64 iLimit = -2;
668     if( zRight ){
669       sqlite3DecOrHexToI64(zRight, &iLimit);
670       if( iLimit<-1 ) iLimit = -1;
671     }
672     iLimit = sqlite3PagerJournalSizeLimit(pPager, iLimit);
673     returnSingleInt(v, iLimit);
674     break;
675   }
676 
677 #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
678 
679   /*
680   **  PRAGMA [schema.]auto_vacuum
681   **  PRAGMA [schema.]auto_vacuum=N
682   **
683   ** Get or set the value of the database 'auto-vacuum' parameter.
684   ** The value is one of:  0 NONE 1 FULL 2 INCREMENTAL
685   */
686 #ifndef SQLITE_OMIT_AUTOVACUUM
687   case PragTyp_AUTO_VACUUM: {
688     Btree *pBt = pDb->pBt;
689     assert( pBt!=0 );
690     if( !zRight ){
691       returnSingleInt(v, sqlite3BtreeGetAutoVacuum(pBt));
692     }else{
693       int eAuto = getAutoVacuum(zRight);
694       assert( eAuto>=0 && eAuto<=2 );
695       db->nextAutovac = (u8)eAuto;
696       /* Call SetAutoVacuum() to set initialize the internal auto and
697       ** incr-vacuum flags. This is required in case this connection
698       ** creates the database file. It is important that it is created
699       ** as an auto-vacuum capable db.
700       */
701       rc = sqlite3BtreeSetAutoVacuum(pBt, eAuto);
702       if( rc==SQLITE_OK && (eAuto==1 || eAuto==2) ){
703         /* When setting the auto_vacuum mode to either "full" or
704         ** "incremental", write the value of meta[6] in the database
705         ** file. Before writing to meta[6], check that meta[3] indicates
706         ** that this really is an auto-vacuum capable database.
707         */
708         static const int iLn = VDBE_OFFSET_LINENO(2);
709         static const VdbeOpList setMeta6[] = {
710           { OP_Transaction,    0,         1,                 0},    /* 0 */
711           { OP_ReadCookie,     0,         1,         BTREE_LARGEST_ROOT_PAGE},
712           { OP_If,             1,         0,                 0},    /* 2 */
713           { OP_Halt,           SQLITE_OK, OE_Abort,          0},    /* 3 */
714           { OP_SetCookie,      0,         BTREE_INCR_VACUUM, 0},    /* 4 */
715         };
716         VdbeOp *aOp;
717         int iAddr = sqlite3VdbeCurrentAddr(v);
718         sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setMeta6));
719         aOp = sqlite3VdbeAddOpList(v, ArraySize(setMeta6), setMeta6, iLn);
720         if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
721         aOp[0].p1 = iDb;
722         aOp[1].p1 = iDb;
723         aOp[2].p2 = iAddr+4;
724         aOp[4].p1 = iDb;
725         aOp[4].p3 = eAuto - 1;
726         sqlite3VdbeUsesBtree(v, iDb);
727       }
728     }
729     break;
730   }
731 #endif
732 
733   /*
734   **  PRAGMA [schema.]incremental_vacuum(N)
735   **
736   ** Do N steps of incremental vacuuming on a database.
737   */
738 #ifndef SQLITE_OMIT_AUTOVACUUM
739   case PragTyp_INCREMENTAL_VACUUM: {
740     int iLimit, addr;
741     if( zRight==0 || !sqlite3GetInt32(zRight, &iLimit) || iLimit<=0 ){
742       iLimit = 0x7fffffff;
743     }
744     sqlite3BeginWriteOperation(pParse, 0, iDb);
745     sqlite3VdbeAddOp2(v, OP_Integer, iLimit, 1);
746     addr = sqlite3VdbeAddOp1(v, OP_IncrVacuum, iDb); VdbeCoverage(v);
747     sqlite3VdbeAddOp1(v, OP_ResultRow, 1);
748     sqlite3VdbeAddOp2(v, OP_AddImm, 1, -1);
749     sqlite3VdbeAddOp2(v, OP_IfPos, 1, addr); VdbeCoverage(v);
750     sqlite3VdbeJumpHere(v, addr);
751     break;
752   }
753 #endif
754 
755 #ifndef SQLITE_OMIT_PAGER_PRAGMAS
756   /*
757   **  PRAGMA [schema.]cache_size
758   **  PRAGMA [schema.]cache_size=N
759   **
760   ** The first form reports the current local setting for the
761   ** page cache size. The second form sets the local
762   ** page cache size value.  If N is positive then that is the
763   ** number of pages in the cache.  If N is negative, then the
764   ** number of pages is adjusted so that the cache uses -N kibibytes
765   ** of memory.
766   */
767   case PragTyp_CACHE_SIZE: {
768     assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
769     if( !zRight ){
770       returnSingleInt(v, pDb->pSchema->cache_size);
771     }else{
772       int size = sqlite3Atoi(zRight);
773       pDb->pSchema->cache_size = size;
774       sqlite3BtreeSetCacheSize(pDb->pBt, pDb->pSchema->cache_size);
775     }
776     break;
777   }
778 
779   /*
780   **  PRAGMA [schema.]cache_spill
781   **  PRAGMA cache_spill=BOOLEAN
782   **  PRAGMA [schema.]cache_spill=N
783   **
784   ** The first form reports the current local setting for the
785   ** page cache spill size. The second form turns cache spill on
786   ** or off.  When turnning cache spill on, the size is set to the
787   ** current cache_size.  The third form sets a spill size that
788   ** may be different form the cache size.
789   ** If N is positive then that is the
790   ** number of pages in the cache.  If N is negative, then the
791   ** number of pages is adjusted so that the cache uses -N kibibytes
792   ** of memory.
793   **
794   ** If the number of cache_spill pages is less then the number of
795   ** cache_size pages, no spilling occurs until the page count exceeds
796   ** the number of cache_size pages.
797   **
798   ** The cache_spill=BOOLEAN setting applies to all attached schemas,
799   ** not just the schema specified.
800   */
801   case PragTyp_CACHE_SPILL: {
802     assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
803     if( !zRight ){
804       returnSingleInt(v,
805          (db->flags & SQLITE_CacheSpill)==0 ? 0 :
806             sqlite3BtreeSetSpillSize(pDb->pBt,0));
807     }else{
808       int size = 1;
809       if( sqlite3GetInt32(zRight, &size) ){
810         sqlite3BtreeSetSpillSize(pDb->pBt, size);
811       }
812       if( sqlite3GetBoolean(zRight, size!=0) ){
813         db->flags |= SQLITE_CacheSpill;
814       }else{
815         db->flags &= ~SQLITE_CacheSpill;
816       }
817       setAllPagerFlags(db);
818     }
819     break;
820   }
821 
822   /*
823   **  PRAGMA [schema.]mmap_size(N)
824   **
825   ** Used to set mapping size limit. The mapping size limit is
826   ** used to limit the aggregate size of all memory mapped regions of the
827   ** database file. If this parameter is set to zero, then memory mapping
828   ** is not used at all.  If N is negative, then the default memory map
829   ** limit determined by sqlite3_config(SQLITE_CONFIG_MMAP_SIZE) is set.
830   ** The parameter N is measured in bytes.
831   **
832   ** This value is advisory.  The underlying VFS is free to memory map
833   ** as little or as much as it wants.  Except, if N is set to 0 then the
834   ** upper layers will never invoke the xFetch interfaces to the VFS.
835   */
836   case PragTyp_MMAP_SIZE: {
837     sqlite3_int64 sz;
838 #if SQLITE_MAX_MMAP_SIZE>0
839     assert( sqlite3SchemaMutexHeld(db, iDb, 0) );
840     if( zRight ){
841       int ii;
842       sqlite3DecOrHexToI64(zRight, &sz);
843       if( sz<0 ) sz = sqlite3GlobalConfig.szMmap;
844       if( pId2->n==0 ) db->szMmap = sz;
845       for(ii=db->nDb-1; ii>=0; ii--){
846         if( db->aDb[ii].pBt && (ii==iDb || pId2->n==0) ){
847           sqlite3BtreeSetMmapLimit(db->aDb[ii].pBt, sz);
848         }
849       }
850     }
851     sz = -1;
852     rc = sqlite3_file_control(db, zDb, SQLITE_FCNTL_MMAP_SIZE, &sz);
853 #else
854     sz = 0;
855     rc = SQLITE_OK;
856 #endif
857     if( rc==SQLITE_OK ){
858       returnSingleInt(v, sz);
859     }else if( rc!=SQLITE_NOTFOUND ){
860       pParse->nErr++;
861       pParse->rc = rc;
862     }
863     break;
864   }
865 
866   /*
867   **   PRAGMA temp_store
868   **   PRAGMA temp_store = "default"|"memory"|"file"
869   **
870   ** Return or set the local value of the temp_store flag.  Changing
871   ** the local value does not make changes to the disk file and the default
872   ** value will be restored the next time the database is opened.
873   **
874   ** Note that it is possible for the library compile-time options to
875   ** override this setting
876   */
877   case PragTyp_TEMP_STORE: {
878     if( !zRight ){
879       returnSingleInt(v, db->temp_store);
880     }else{
881       changeTempStorage(pParse, zRight);
882     }
883     break;
884   }
885 
886   /*
887   **   PRAGMA temp_store_directory
888   **   PRAGMA temp_store_directory = ""|"directory_name"
889   **
890   ** Return or set the local value of the temp_store_directory flag.  Changing
891   ** the value sets a specific directory to be used for temporary files.
892   ** Setting to a null string reverts to the default temporary directory search.
893   ** If temporary directory is changed, then invalidateTempStorage.
894   **
895   */
896   case PragTyp_TEMP_STORE_DIRECTORY: {
897     if( !zRight ){
898       returnSingleText(v, sqlite3_temp_directory);
899     }else{
900 #ifndef SQLITE_OMIT_WSD
901       if( zRight[0] ){
902         int res;
903         rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
904         if( rc!=SQLITE_OK || res==0 ){
905           sqlite3ErrorMsg(pParse, "not a writable directory");
906           goto pragma_out;
907         }
908       }
909       if( SQLITE_TEMP_STORE==0
910        || (SQLITE_TEMP_STORE==1 && db->temp_store<=1)
911        || (SQLITE_TEMP_STORE==2 && db->temp_store==1)
912       ){
913         invalidateTempStorage(pParse);
914       }
915       sqlite3_free(sqlite3_temp_directory);
916       if( zRight[0] ){
917         sqlite3_temp_directory = sqlite3_mprintf("%s", zRight);
918       }else{
919         sqlite3_temp_directory = 0;
920       }
921 #endif /* SQLITE_OMIT_WSD */
922     }
923     break;
924   }
925 
926 #if SQLITE_OS_WIN
927   /*
928   **   PRAGMA data_store_directory
929   **   PRAGMA data_store_directory = ""|"directory_name"
930   **
931   ** Return or set the local value of the data_store_directory flag.  Changing
932   ** the value sets a specific directory to be used for database files that
933   ** were specified with a relative pathname.  Setting to a null string reverts
934   ** to the default database directory, which for database files specified with
935   ** a relative path will probably be based on the current directory for the
936   ** process.  Database file specified with an absolute path are not impacted
937   ** by this setting, regardless of its value.
938   **
939   */
940   case PragTyp_DATA_STORE_DIRECTORY: {
941     if( !zRight ){
942       returnSingleText(v, sqlite3_data_directory);
943     }else{
944 #ifndef SQLITE_OMIT_WSD
945       if( zRight[0] ){
946         int res;
947         rc = sqlite3OsAccess(db->pVfs, zRight, SQLITE_ACCESS_READWRITE, &res);
948         if( rc!=SQLITE_OK || res==0 ){
949           sqlite3ErrorMsg(pParse, "not a writable directory");
950           goto pragma_out;
951         }
952       }
953       sqlite3_free(sqlite3_data_directory);
954       if( zRight[0] ){
955         sqlite3_data_directory = sqlite3_mprintf("%s", zRight);
956       }else{
957         sqlite3_data_directory = 0;
958       }
959 #endif /* SQLITE_OMIT_WSD */
960     }
961     break;
962   }
963 #endif
964 
965 #if SQLITE_ENABLE_LOCKING_STYLE
966   /*
967   **   PRAGMA [schema.]lock_proxy_file
968   **   PRAGMA [schema.]lock_proxy_file = ":auto:"|"lock_file_path"
969   **
970   ** Return or set the value of the lock_proxy_file flag.  Changing
971   ** the value sets a specific file to be used for database access locks.
972   **
973   */
974   case PragTyp_LOCK_PROXY_FILE: {
975     if( !zRight ){
976       Pager *pPager = sqlite3BtreePager(pDb->pBt);
977       char *proxy_file_path = NULL;
978       sqlite3_file *pFile = sqlite3PagerFile(pPager);
979       sqlite3OsFileControlHint(pFile, SQLITE_GET_LOCKPROXYFILE,
980                            &proxy_file_path);
981       returnSingleText(v, proxy_file_path);
982     }else{
983       Pager *pPager = sqlite3BtreePager(pDb->pBt);
984       sqlite3_file *pFile = sqlite3PagerFile(pPager);
985       int res;
986       if( zRight[0] ){
987         res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
988                                      zRight);
989       } else {
990         res=sqlite3OsFileControl(pFile, SQLITE_SET_LOCKPROXYFILE,
991                                      NULL);
992       }
993       if( res!=SQLITE_OK ){
994         sqlite3ErrorMsg(pParse, "failed to set lock proxy file");
995         goto pragma_out;
996       }
997     }
998     break;
999   }
1000 #endif /* SQLITE_ENABLE_LOCKING_STYLE */
1001 
1002   /*
1003   **   PRAGMA [schema.]synchronous
1004   **   PRAGMA [schema.]synchronous=OFF|ON|NORMAL|FULL|EXTRA
1005   **
1006   ** Return or set the local value of the synchronous flag.  Changing
1007   ** the local value does not make changes to the disk file and the
1008   ** default value will be restored the next time the database is
1009   ** opened.
1010   */
1011   case PragTyp_SYNCHRONOUS: {
1012     if( !zRight ){
1013       returnSingleInt(v, pDb->safety_level-1);
1014     }else{
1015       if( !db->autoCommit ){
1016         sqlite3ErrorMsg(pParse,
1017             "Safety level may not be changed inside a transaction");
1018       }else if( iDb!=1 ){
1019         int iLevel = (getSafetyLevel(zRight,0,1)+1) & PAGER_SYNCHRONOUS_MASK;
1020         if( iLevel==0 ) iLevel = 1;
1021         pDb->safety_level = iLevel;
1022         pDb->bSyncSet = 1;
1023         setAllPagerFlags(db);
1024       }
1025     }
1026     break;
1027   }
1028 #endif /* SQLITE_OMIT_PAGER_PRAGMAS */
1029 
1030 #ifndef SQLITE_OMIT_FLAG_PRAGMAS
1031   case PragTyp_FLAG: {
1032     if( zRight==0 ){
1033       setPragmaResultColumnNames(v, pPragma);
1034       returnSingleInt(v, (db->flags & pPragma->iArg)!=0 );
1035     }else{
1036       int mask = pPragma->iArg;    /* Mask of bits to set or clear. */
1037       if( db->autoCommit==0 ){
1038         /* Foreign key support may not be enabled or disabled while not
1039         ** in auto-commit mode.  */
1040         mask &= ~(SQLITE_ForeignKeys);
1041       }
1042 #if SQLITE_USER_AUTHENTICATION
1043       if( db->auth.authLevel==UAUTH_User ){
1044         /* Do not allow non-admin users to modify the schema arbitrarily */
1045         mask &= ~(SQLITE_WriteSchema);
1046       }
1047 #endif
1048 
1049       if( sqlite3GetBoolean(zRight, 0) ){
1050         db->flags |= mask;
1051       }else{
1052         db->flags &= ~mask;
1053         if( mask==SQLITE_DeferFKs ) db->nDeferredImmCons = 0;
1054       }
1055 
1056       /* Many of the flag-pragmas modify the code generated by the SQL
1057       ** compiler (eg. count_changes). So add an opcode to expire all
1058       ** compiled SQL statements after modifying a pragma value.
1059       */
1060       sqlite3VdbeAddOp0(v, OP_Expire);
1061       setAllPagerFlags(db);
1062     }
1063     break;
1064   }
1065 #endif /* SQLITE_OMIT_FLAG_PRAGMAS */
1066 
1067 #ifndef SQLITE_OMIT_SCHEMA_PRAGMAS
1068   /*
1069   **   PRAGMA table_info(<table>)
1070   **
1071   ** Return a single row for each column of the named table. The columns of
1072   ** the returned data set are:
1073   **
1074   ** cid:        Column id (numbered from left to right, starting at 0)
1075   ** name:       Column name
1076   ** type:       Column declaration type.
1077   ** notnull:    True if 'NOT NULL' is part of column declaration
1078   ** dflt_value: The default value for the column, if any.
1079   */
1080   case PragTyp_TABLE_INFO: if( zRight ){
1081     Table *pTab;
1082     pTab = sqlite3LocateTable(pParse, LOCATE_NOERR, zRight, zDb);
1083     if( pTab ){
1084       int i, k;
1085       int nHidden = 0;
1086       Column *pCol;
1087       Index *pPk = sqlite3PrimaryKeyIndex(pTab);
1088       pParse->nMem = 6;
1089       sqlite3CodeVerifySchema(pParse, iDb);
1090       sqlite3ViewGetColumnNames(pParse, pTab);
1091       for(i=0, pCol=pTab->aCol; i<pTab->nCol; i++, pCol++){
1092         if( IsHiddenColumn(pCol) ){
1093           nHidden++;
1094           continue;
1095         }
1096         if( (pCol->colFlags & COLFLAG_PRIMKEY)==0 ){
1097           k = 0;
1098         }else if( pPk==0 ){
1099           k = 1;
1100         }else{
1101           for(k=1; k<=pTab->nCol && pPk->aiColumn[k-1]!=i; k++){}
1102         }
1103         assert( pCol->pDflt==0 || pCol->pDflt->op==TK_SPAN );
1104         sqlite3VdbeMultiLoad(v, 1, "issisi",
1105                i-nHidden,
1106                pCol->zName,
1107                sqlite3ColumnType(pCol,""),
1108                pCol->notNull ? 1 : 0,
1109                pCol->pDflt ? pCol->pDflt->u.zToken : 0,
1110                k);
1111         sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 6);
1112       }
1113     }
1114   }
1115   break;
1116 
1117 #ifdef SQLITE_DEBUG
1118   case PragTyp_STATS: {
1119     Index *pIdx;
1120     HashElem *i;
1121     pParse->nMem = 5;
1122     sqlite3CodeVerifySchema(pParse, iDb);
1123     for(i=sqliteHashFirst(&pDb->pSchema->tblHash); i; i=sqliteHashNext(i)){
1124       Table *pTab = sqliteHashData(i);
1125       sqlite3VdbeMultiLoad(v, 1, "ssiii",
1126            pTab->zName,
1127            0,
1128            pTab->szTabRow,
1129            pTab->nRowLogEst,
1130            pTab->tabFlags);
1131       sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
1132       for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1133         sqlite3VdbeMultiLoad(v, 2, "siii",
1134            pIdx->zName,
1135            pIdx->szIdxRow,
1136            pIdx->aiRowLogEst[0],
1137            pIdx->hasStat1);
1138         sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
1139       }
1140     }
1141   }
1142   break;
1143 #endif
1144 
1145   case PragTyp_INDEX_INFO: if( zRight ){
1146     Index *pIdx;
1147     Table *pTab;
1148     pIdx = sqlite3FindIndex(db, zRight, zDb);
1149     if( pIdx ){
1150       int i;
1151       int mx;
1152       if( pPragma->iArg ){
1153         /* PRAGMA index_xinfo (newer version with more rows and columns) */
1154         mx = pIdx->nColumn;
1155         pParse->nMem = 6;
1156       }else{
1157         /* PRAGMA index_info (legacy version) */
1158         mx = pIdx->nKeyCol;
1159         pParse->nMem = 3;
1160       }
1161       pTab = pIdx->pTable;
1162       sqlite3CodeVerifySchema(pParse, iDb);
1163       assert( pParse->nMem<=pPragma->nPragCName );
1164       for(i=0; i<mx; i++){
1165         i16 cnum = pIdx->aiColumn[i];
1166         sqlite3VdbeMultiLoad(v, 1, "iis", i, cnum,
1167                              cnum<0 ? 0 : pTab->aCol[cnum].zName);
1168         if( pPragma->iArg ){
1169           sqlite3VdbeMultiLoad(v, 4, "isi",
1170             pIdx->aSortOrder[i],
1171             pIdx->azColl[i],
1172             i<pIdx->nKeyCol);
1173         }
1174         sqlite3VdbeAddOp2(v, OP_ResultRow, 1, pParse->nMem);
1175       }
1176     }
1177   }
1178   break;
1179 
1180   case PragTyp_INDEX_LIST: if( zRight ){
1181     Index *pIdx;
1182     Table *pTab;
1183     int i;
1184     pTab = sqlite3FindTable(db, zRight, zDb);
1185     if( pTab ){
1186       pParse->nMem = 5;
1187       sqlite3CodeVerifySchema(pParse, iDb);
1188       for(pIdx=pTab->pIndex, i=0; pIdx; pIdx=pIdx->pNext, i++){
1189         const char *azOrigin[] = { "c", "u", "pk" };
1190         sqlite3VdbeMultiLoad(v, 1, "isisi",
1191            i,
1192            pIdx->zName,
1193            IsUniqueIndex(pIdx),
1194            azOrigin[pIdx->idxType],
1195            pIdx->pPartIdxWhere!=0);
1196         sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 5);
1197       }
1198     }
1199   }
1200   break;
1201 
1202   case PragTyp_DATABASE_LIST: {
1203     int i;
1204     pParse->nMem = 3;
1205     for(i=0; i<db->nDb; i++){
1206       if( db->aDb[i].pBt==0 ) continue;
1207       assert( db->aDb[i].zDbSName!=0 );
1208       sqlite3VdbeMultiLoad(v, 1, "iss",
1209          i,
1210          db->aDb[i].zDbSName,
1211          sqlite3BtreeGetFilename(db->aDb[i].pBt));
1212       sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
1213     }
1214   }
1215   break;
1216 
1217   case PragTyp_COLLATION_LIST: {
1218     int i = 0;
1219     HashElem *p;
1220     pParse->nMem = 2;
1221     for(p=sqliteHashFirst(&db->aCollSeq); p; p=sqliteHashNext(p)){
1222       CollSeq *pColl = (CollSeq *)sqliteHashData(p);
1223       sqlite3VdbeMultiLoad(v, 1, "is", i++, pColl->zName);
1224       sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 2);
1225     }
1226   }
1227   break;
1228 #endif /* SQLITE_OMIT_SCHEMA_PRAGMAS */
1229 
1230 #ifndef SQLITE_OMIT_FOREIGN_KEY
1231   case PragTyp_FOREIGN_KEY_LIST: if( zRight ){
1232     FKey *pFK;
1233     Table *pTab;
1234     pTab = sqlite3FindTable(db, zRight, zDb);
1235     if( pTab ){
1236       pFK = pTab->pFKey;
1237       if( pFK ){
1238         int i = 0;
1239         pParse->nMem = 8;
1240         sqlite3CodeVerifySchema(pParse, iDb);
1241         while(pFK){
1242           int j;
1243           for(j=0; j<pFK->nCol; j++){
1244             sqlite3VdbeMultiLoad(v, 1, "iissssss",
1245                    i,
1246                    j,
1247                    pFK->zTo,
1248                    pTab->aCol[pFK->aCol[j].iFrom].zName,
1249                    pFK->aCol[j].zCol,
1250                    actionName(pFK->aAction[1]),  /* ON UPDATE */
1251                    actionName(pFK->aAction[0]),  /* ON DELETE */
1252                    "NONE");
1253             sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 8);
1254           }
1255           ++i;
1256           pFK = pFK->pNextFrom;
1257         }
1258       }
1259     }
1260   }
1261   break;
1262 #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
1263 
1264 #ifndef SQLITE_OMIT_FOREIGN_KEY
1265 #ifndef SQLITE_OMIT_TRIGGER
1266   case PragTyp_FOREIGN_KEY_CHECK: {
1267     FKey *pFK;             /* A foreign key constraint */
1268     Table *pTab;           /* Child table contain "REFERENCES" keyword */
1269     Table *pParent;        /* Parent table that child points to */
1270     Index *pIdx;           /* Index in the parent table */
1271     int i;                 /* Loop counter:  Foreign key number for pTab */
1272     int j;                 /* Loop counter:  Field of the foreign key */
1273     HashElem *k;           /* Loop counter:  Next table in schema */
1274     int x;                 /* result variable */
1275     int regResult;         /* 3 registers to hold a result row */
1276     int regKey;            /* Register to hold key for checking the FK */
1277     int regRow;            /* Registers to hold a row from pTab */
1278     int addrTop;           /* Top of a loop checking foreign keys */
1279     int addrOk;            /* Jump here if the key is OK */
1280     int *aiCols;           /* child to parent column mapping */
1281 
1282     regResult = pParse->nMem+1;
1283     pParse->nMem += 4;
1284     regKey = ++pParse->nMem;
1285     regRow = ++pParse->nMem;
1286     sqlite3CodeVerifySchema(pParse, iDb);
1287     k = sqliteHashFirst(&db->aDb[iDb].pSchema->tblHash);
1288     while( k ){
1289       if( zRight ){
1290         pTab = sqlite3LocateTable(pParse, 0, zRight, zDb);
1291         k = 0;
1292       }else{
1293         pTab = (Table*)sqliteHashData(k);
1294         k = sqliteHashNext(k);
1295       }
1296       if( pTab==0 || pTab->pFKey==0 ) continue;
1297       sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
1298       if( pTab->nCol+regRow>pParse->nMem ) pParse->nMem = pTab->nCol + regRow;
1299       sqlite3OpenTable(pParse, 0, iDb, pTab, OP_OpenRead);
1300       sqlite3VdbeLoadString(v, regResult, pTab->zName);
1301       for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
1302         pParent = sqlite3FindTable(db, pFK->zTo, zDb);
1303         if( pParent==0 ) continue;
1304         pIdx = 0;
1305         sqlite3TableLock(pParse, iDb, pParent->tnum, 0, pParent->zName);
1306         x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, 0);
1307         if( x==0 ){
1308           if( pIdx==0 ){
1309             sqlite3OpenTable(pParse, i, iDb, pParent, OP_OpenRead);
1310           }else{
1311             sqlite3VdbeAddOp3(v, OP_OpenRead, i, pIdx->tnum, iDb);
1312             sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1313           }
1314         }else{
1315           k = 0;
1316           break;
1317         }
1318       }
1319       assert( pParse->nErr>0 || pFK==0 );
1320       if( pFK ) break;
1321       if( pParse->nTab<i ) pParse->nTab = i;
1322       addrTop = sqlite3VdbeAddOp1(v, OP_Rewind, 0); VdbeCoverage(v);
1323       for(i=1, pFK=pTab->pFKey; pFK; i++, pFK=pFK->pNextFrom){
1324         pParent = sqlite3FindTable(db, pFK->zTo, zDb);
1325         pIdx = 0;
1326         aiCols = 0;
1327         if( pParent ){
1328           x = sqlite3FkLocateIndex(pParse, pParent, pFK, &pIdx, &aiCols);
1329           assert( x==0 );
1330         }
1331         addrOk = sqlite3VdbeMakeLabel(v);
1332 
1333         /* Generate code to read the child key values into registers
1334         ** regRow..regRow+n. If any of the child key values are NULL, this
1335         ** row cannot cause an FK violation. Jump directly to addrOk in
1336         ** this case. */
1337         for(j=0; j<pFK->nCol; j++){
1338           int iCol = aiCols ? aiCols[j] : pFK->aCol[j].iFrom;
1339           sqlite3ExprCodeGetColumnOfTable(v, pTab, 0, iCol, regRow+j);
1340           sqlite3VdbeAddOp2(v, OP_IsNull, regRow+j, addrOk); VdbeCoverage(v);
1341         }
1342 
1343         /* Generate code to query the parent index for a matching parent
1344         ** key. If a match is found, jump to addrOk. */
1345         if( pIdx ){
1346           sqlite3VdbeAddOp4(v, OP_MakeRecord, regRow, pFK->nCol, regKey,
1347               sqlite3IndexAffinityStr(db,pIdx), pFK->nCol);
1348           sqlite3VdbeAddOp4Int(v, OP_Found, i, addrOk, regKey, 0);
1349           VdbeCoverage(v);
1350         }else if( pParent ){
1351           int jmp = sqlite3VdbeCurrentAddr(v)+2;
1352           sqlite3VdbeAddOp3(v, OP_SeekRowid, i, jmp, regRow); VdbeCoverage(v);
1353           sqlite3VdbeGoto(v, addrOk);
1354           assert( pFK->nCol==1 );
1355         }
1356 
1357         /* Generate code to report an FK violation to the caller. */
1358         if( HasRowid(pTab) ){
1359           sqlite3VdbeAddOp2(v, OP_Rowid, 0, regResult+1);
1360         }else{
1361           sqlite3VdbeAddOp2(v, OP_Null, 0, regResult+1);
1362         }
1363         sqlite3VdbeMultiLoad(v, regResult+2, "si", pFK->zTo, i-1);
1364         sqlite3VdbeAddOp2(v, OP_ResultRow, regResult, 4);
1365         sqlite3VdbeResolveLabel(v, addrOk);
1366         sqlite3DbFree(db, aiCols);
1367       }
1368       sqlite3VdbeAddOp2(v, OP_Next, 0, addrTop+1); VdbeCoverage(v);
1369       sqlite3VdbeJumpHere(v, addrTop);
1370     }
1371   }
1372   break;
1373 #endif /* !defined(SQLITE_OMIT_TRIGGER) */
1374 #endif /* !defined(SQLITE_OMIT_FOREIGN_KEY) */
1375 
1376 #ifndef NDEBUG
1377   case PragTyp_PARSER_TRACE: {
1378     if( zRight ){
1379       if( sqlite3GetBoolean(zRight, 0) ){
1380         sqlite3ParserTrace(stdout, "parser: ");
1381       }else{
1382         sqlite3ParserTrace(0, 0);
1383       }
1384     }
1385   }
1386   break;
1387 #endif
1388 
1389   /* Reinstall the LIKE and GLOB functions.  The variant of LIKE
1390   ** used will be case sensitive or not depending on the RHS.
1391   */
1392   case PragTyp_CASE_SENSITIVE_LIKE: {
1393     if( zRight ){
1394       sqlite3RegisterLikeFunctions(db, sqlite3GetBoolean(zRight, 0));
1395     }
1396   }
1397   break;
1398 
1399 #ifndef SQLITE_INTEGRITY_CHECK_ERROR_MAX
1400 # define SQLITE_INTEGRITY_CHECK_ERROR_MAX 100
1401 #endif
1402 
1403 #ifndef SQLITE_OMIT_INTEGRITY_CHECK
1404   /*    PRAGMA integrity_check
1405   **    PRAGMA integrity_check(N)
1406   **    PRAGMA quick_check
1407   **    PRAGMA quick_check(N)
1408   **
1409   ** Verify the integrity of the database.
1410   **
1411   ** The "quick_check" is reduced version of
1412   ** integrity_check designed to detect most database corruption
1413   ** without the overhead of cross-checking indexes.  Quick_check
1414   ** is linear time wherease integrity_check is O(NlogN).
1415   */
1416   case PragTyp_INTEGRITY_CHECK: {
1417     int i, j, addr, mxErr;
1418 
1419     int isQuick = (sqlite3Tolower(zLeft[0])=='q');
1420 
1421     /* If the PRAGMA command was of the form "PRAGMA <db>.integrity_check",
1422     ** then iDb is set to the index of the database identified by <db>.
1423     ** In this case, the integrity of database iDb only is verified by
1424     ** the VDBE created below.
1425     **
1426     ** Otherwise, if the command was simply "PRAGMA integrity_check" (or
1427     ** "PRAGMA quick_check"), then iDb is set to 0. In this case, set iDb
1428     ** to -1 here, to indicate that the VDBE should verify the integrity
1429     ** of all attached databases.  */
1430     assert( iDb>=0 );
1431     assert( iDb==0 || pId2->z );
1432     if( pId2->z==0 ) iDb = -1;
1433 
1434     /* Initialize the VDBE program */
1435     pParse->nMem = 6;
1436 
1437     /* Set the maximum error count */
1438     mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
1439     if( zRight ){
1440       sqlite3GetInt32(zRight, &mxErr);
1441       if( mxErr<=0 ){
1442         mxErr = SQLITE_INTEGRITY_CHECK_ERROR_MAX;
1443       }
1444     }
1445     sqlite3VdbeAddOp2(v, OP_Integer, mxErr-1, 1); /* reg[1] holds errors left */
1446 
1447     /* Do an integrity check on each database file */
1448     for(i=0; i<db->nDb; i++){
1449       HashElem *x;
1450       Hash *pTbls;
1451       int *aRoot;
1452       int cnt = 0;
1453       int mxIdx = 0;
1454       int nIdx;
1455 
1456       if( OMIT_TEMPDB && i==1 ) continue;
1457       if( iDb>=0 && i!=iDb ) continue;
1458 
1459       sqlite3CodeVerifySchema(pParse, i);
1460 
1461       /* Do an integrity check of the B-Tree
1462       **
1463       ** Begin by finding the root pages numbers
1464       ** for all tables and indices in the database.
1465       */
1466       assert( sqlite3SchemaMutexHeld(db, i, 0) );
1467       pTbls = &db->aDb[i].pSchema->tblHash;
1468       for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
1469         Table *pTab = sqliteHashData(x);
1470         Index *pIdx;
1471         if( HasRowid(pTab) ) cnt++;
1472         for(nIdx=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, nIdx++){ cnt++; }
1473         if( nIdx>mxIdx ) mxIdx = nIdx;
1474       }
1475       aRoot = sqlite3DbMallocRawNN(db, sizeof(int)*(cnt+1));
1476       if( aRoot==0 ) break;
1477       for(cnt=0, x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
1478         Table *pTab = sqliteHashData(x);
1479         Index *pIdx;
1480         if( HasRowid(pTab) ) aRoot[cnt++] = pTab->tnum;
1481         for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1482           aRoot[cnt++] = pIdx->tnum;
1483         }
1484       }
1485       aRoot[cnt] = 0;
1486 
1487       /* Make sure sufficient number of registers have been allocated */
1488       pParse->nMem = MAX( pParse->nMem, 8+mxIdx );
1489 
1490       /* Do the b-tree integrity checks */
1491       sqlite3VdbeAddOp4(v, OP_IntegrityCk, 2, cnt, 1, (char*)aRoot,P4_INTARRAY);
1492       sqlite3VdbeChangeP5(v, (u8)i);
1493       addr = sqlite3VdbeAddOp1(v, OP_IsNull, 2); VdbeCoverage(v);
1494       sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0,
1495          sqlite3MPrintf(db, "*** in database %s ***\n", db->aDb[i].zDbSName),
1496          P4_DYNAMIC);
1497       sqlite3VdbeAddOp3(v, OP_Move, 2, 4, 1);
1498       sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 2);
1499       integrityCheckResultRow(v, 2);
1500       sqlite3VdbeJumpHere(v, addr);
1501 
1502       /* Make sure all the indices are constructed correctly.
1503       */
1504       for(x=sqliteHashFirst(pTbls); x; x=sqliteHashNext(x)){
1505         Table *pTab = sqliteHashData(x);
1506         Index *pIdx, *pPk;
1507         Index *pPrior = 0;
1508         int loopTop;
1509         int iDataCur, iIdxCur;
1510         int r1 = -1;
1511 
1512         if( pTab->tnum<1 ) continue;  /* Skip VIEWs or VIRTUAL TABLEs */
1513         if( pTab->pCheck==0
1514          && (pTab->tabFlags & TF_HasNotNull)==0
1515          && (pTab->pIndex==0 || isQuick)
1516         ){
1517           continue;  /* No additional checks needed for this table */
1518         }
1519         pPk = HasRowid(pTab) ? 0 : sqlite3PrimaryKeyIndex(pTab);
1520         sqlite3ExprCacheClear(pParse);
1521         sqlite3OpenTableAndIndices(pParse, pTab, OP_OpenRead, 0,
1522                                    1, 0, &iDataCur, &iIdxCur);
1523         sqlite3VdbeAddOp2(v, OP_Integer, 0, 7);
1524         for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
1525           sqlite3VdbeAddOp2(v, OP_Integer, 0, 8+j); /* index entries counter */
1526         }
1527         assert( pParse->nMem>=8+j );
1528         assert( sqlite3NoTempsInRange(pParse,1,7+j) );
1529         sqlite3VdbeAddOp2(v, OP_Rewind, iDataCur, 0); VdbeCoverage(v);
1530         loopTop = sqlite3VdbeAddOp2(v, OP_AddImm, 7, 1);
1531         /* Verify that all NOT NULL columns really are NOT NULL */
1532         for(j=0; j<pTab->nCol; j++){
1533           char *zErr;
1534           int jmp2;
1535           if( j==pTab->iPKey ) continue;
1536           if( pTab->aCol[j].notNull==0 ) continue;
1537           sqlite3ExprCodeGetColumnOfTable(v, pTab, iDataCur, j, 3);
1538           sqlite3VdbeChangeP5(v, OPFLAG_TYPEOFARG);
1539           jmp2 = sqlite3VdbeAddOp1(v, OP_NotNull, 3); VdbeCoverage(v);
1540           zErr = sqlite3MPrintf(db, "NULL value in %s.%s", pTab->zName,
1541                               pTab->aCol[j].zName);
1542           sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
1543           integrityCheckResultRow(v, 3);
1544           sqlite3VdbeJumpHere(v, jmp2);
1545         }
1546         /* Verify CHECK constraints */
1547         if( pTab->pCheck && (db->flags & SQLITE_IgnoreChecks)==0 ){
1548           ExprList *pCheck = sqlite3ExprListDup(db, pTab->pCheck, 0);
1549           if( db->mallocFailed==0 ){
1550             int addrCkFault = sqlite3VdbeMakeLabel(v);
1551             int addrCkOk = sqlite3VdbeMakeLabel(v);
1552             char *zErr;
1553             int k;
1554             pParse->iSelfTab = iDataCur;
1555             sqlite3ExprCachePush(pParse);
1556             for(k=pCheck->nExpr-1; k>0; k--){
1557               sqlite3ExprIfFalse(pParse, pCheck->a[k].pExpr, addrCkFault, 0);
1558             }
1559             sqlite3ExprIfTrue(pParse, pCheck->a[0].pExpr, addrCkOk,
1560                 SQLITE_JUMPIFNULL);
1561             sqlite3VdbeResolveLabel(v, addrCkFault);
1562             zErr = sqlite3MPrintf(db, "CHECK constraint failed in %s",
1563                 pTab->zName);
1564             sqlite3VdbeAddOp4(v, OP_String8, 0, 3, 0, zErr, P4_DYNAMIC);
1565             integrityCheckResultRow(v, 3);
1566             sqlite3VdbeResolveLabel(v, addrCkOk);
1567             sqlite3ExprCachePop(pParse);
1568           }
1569           sqlite3ExprListDelete(db, pCheck);
1570         }
1571         /* Validate index entries for the current row */
1572         for(j=0, pIdx=pTab->pIndex; pIdx && !isQuick; pIdx=pIdx->pNext, j++){
1573           int jmp2, jmp3, jmp4, jmp5;
1574           int ckUniq = sqlite3VdbeMakeLabel(v);
1575           if( pPk==pIdx ) continue;
1576           r1 = sqlite3GenerateIndexKey(pParse, pIdx, iDataCur, 0, 0, &jmp3,
1577                                        pPrior, r1);
1578           pPrior = pIdx;
1579           sqlite3VdbeAddOp2(v, OP_AddImm, 8+j, 1);  /* increment entry count */
1580           /* Verify that an index entry exists for the current table row */
1581           jmp2 = sqlite3VdbeAddOp4Int(v, OP_Found, iIdxCur+j, ckUniq, r1,
1582                                       pIdx->nColumn); VdbeCoverage(v);
1583           sqlite3VdbeLoadString(v, 3, "row ");
1584           sqlite3VdbeAddOp3(v, OP_Concat, 7, 3, 3);
1585           sqlite3VdbeLoadString(v, 4, " missing from index ");
1586           sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
1587           jmp5 = sqlite3VdbeLoadString(v, 4, pIdx->zName);
1588           sqlite3VdbeAddOp3(v, OP_Concat, 4, 3, 3);
1589           jmp4 = integrityCheckResultRow(v, 3);
1590           sqlite3VdbeJumpHere(v, jmp2);
1591           /* For UNIQUE indexes, verify that only one entry exists with the
1592           ** current key.  The entry is unique if (1) any column is NULL
1593           ** or (2) the next entry has a different key */
1594           if( IsUniqueIndex(pIdx) ){
1595             int uniqOk = sqlite3VdbeMakeLabel(v);
1596             int jmp6;
1597             int kk;
1598             for(kk=0; kk<pIdx->nKeyCol; kk++){
1599               int iCol = pIdx->aiColumn[kk];
1600               assert( iCol!=XN_ROWID && iCol<pTab->nCol );
1601               if( iCol>=0 && pTab->aCol[iCol].notNull ) continue;
1602               sqlite3VdbeAddOp2(v, OP_IsNull, r1+kk, uniqOk);
1603               VdbeCoverage(v);
1604             }
1605             jmp6 = sqlite3VdbeAddOp1(v, OP_Next, iIdxCur+j); VdbeCoverage(v);
1606             sqlite3VdbeGoto(v, uniqOk);
1607             sqlite3VdbeJumpHere(v, jmp6);
1608             sqlite3VdbeAddOp4Int(v, OP_IdxGT, iIdxCur+j, uniqOk, r1,
1609                                  pIdx->nKeyCol); VdbeCoverage(v);
1610             sqlite3VdbeLoadString(v, 3, "non-unique entry in index ");
1611             sqlite3VdbeGoto(v, jmp5);
1612             sqlite3VdbeResolveLabel(v, uniqOk);
1613           }
1614           sqlite3VdbeJumpHere(v, jmp4);
1615           sqlite3ResolvePartIdxLabel(pParse, jmp3);
1616         }
1617         sqlite3VdbeAddOp2(v, OP_Next, iDataCur, loopTop); VdbeCoverage(v);
1618         sqlite3VdbeJumpHere(v, loopTop-1);
1619 #ifndef SQLITE_OMIT_BTREECOUNT
1620         if( !isQuick ){
1621           sqlite3VdbeLoadString(v, 2, "wrong # of entries in index ");
1622           for(j=0, pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext, j++){
1623             if( pPk==pIdx ) continue;
1624             sqlite3VdbeAddOp2(v, OP_Count, iIdxCur+j, 3);
1625             addr = sqlite3VdbeAddOp3(v, OP_Eq, 8+j, 0, 3); VdbeCoverage(v);
1626             sqlite3VdbeChangeP5(v, SQLITE_NOTNULL);
1627             sqlite3VdbeLoadString(v, 3, pIdx->zName);
1628             sqlite3VdbeAddOp3(v, OP_Concat, 3, 2, 7);
1629             integrityCheckResultRow(v, 7);
1630             sqlite3VdbeJumpHere(v, addr);
1631           }
1632         }
1633 #endif /* SQLITE_OMIT_BTREECOUNT */
1634       }
1635     }
1636     {
1637       static const int iLn = VDBE_OFFSET_LINENO(2);
1638       static const VdbeOpList endCode[] = {
1639         { OP_AddImm,      1, 0,        0},    /* 0 */
1640         { OP_IfNotZero,   1, 4,        0},    /* 1 */
1641         { OP_String8,     0, 3,        0},    /* 2 */
1642         { OP_ResultRow,   3, 1,        0},    /* 3 */
1643       };
1644       VdbeOp *aOp;
1645 
1646       aOp = sqlite3VdbeAddOpList(v, ArraySize(endCode), endCode, iLn);
1647       if( aOp ){
1648         aOp[0].p2 = 1-mxErr;
1649         aOp[2].p4type = P4_STATIC;
1650         aOp[2].p4.z = "ok";
1651       }
1652     }
1653   }
1654   break;
1655 #endif /* SQLITE_OMIT_INTEGRITY_CHECK */
1656 
1657 #ifndef SQLITE_OMIT_UTF16
1658   /*
1659   **   PRAGMA encoding
1660   **   PRAGMA encoding = "utf-8"|"utf-16"|"utf-16le"|"utf-16be"
1661   **
1662   ** In its first form, this pragma returns the encoding of the main
1663   ** database. If the database is not initialized, it is initialized now.
1664   **
1665   ** The second form of this pragma is a no-op if the main database file
1666   ** has not already been initialized. In this case it sets the default
1667   ** encoding that will be used for the main database file if a new file
1668   ** is created. If an existing main database file is opened, then the
1669   ** default text encoding for the existing database is used.
1670   **
1671   ** In all cases new databases created using the ATTACH command are
1672   ** created to use the same default text encoding as the main database. If
1673   ** the main database has not been initialized and/or created when ATTACH
1674   ** is executed, this is done before the ATTACH operation.
1675   **
1676   ** In the second form this pragma sets the text encoding to be used in
1677   ** new database files created using this database handle. It is only
1678   ** useful if invoked immediately after the main database i
1679   */
1680   case PragTyp_ENCODING: {
1681     static const struct EncName {
1682       char *zName;
1683       u8 enc;
1684     } encnames[] = {
1685       { "UTF8",     SQLITE_UTF8        },
1686       { "UTF-8",    SQLITE_UTF8        },  /* Must be element [1] */
1687       { "UTF-16le", SQLITE_UTF16LE     },  /* Must be element [2] */
1688       { "UTF-16be", SQLITE_UTF16BE     },  /* Must be element [3] */
1689       { "UTF16le",  SQLITE_UTF16LE     },
1690       { "UTF16be",  SQLITE_UTF16BE     },
1691       { "UTF-16",   0                  }, /* SQLITE_UTF16NATIVE */
1692       { "UTF16",    0                  }, /* SQLITE_UTF16NATIVE */
1693       { 0, 0 }
1694     };
1695     const struct EncName *pEnc;
1696     if( !zRight ){    /* "PRAGMA encoding" */
1697       if( sqlite3ReadSchema(pParse) ) goto pragma_out;
1698       assert( encnames[SQLITE_UTF8].enc==SQLITE_UTF8 );
1699       assert( encnames[SQLITE_UTF16LE].enc==SQLITE_UTF16LE );
1700       assert( encnames[SQLITE_UTF16BE].enc==SQLITE_UTF16BE );
1701       returnSingleText(v, encnames[ENC(pParse->db)].zName);
1702     }else{                        /* "PRAGMA encoding = XXX" */
1703       /* Only change the value of sqlite.enc if the database handle is not
1704       ** initialized. If the main database exists, the new sqlite.enc value
1705       ** will be overwritten when the schema is next loaded. If it does not
1706       ** already exists, it will be created to use the new encoding value.
1707       */
1708       if(
1709         !(DbHasProperty(db, 0, DB_SchemaLoaded)) ||
1710         DbHasProperty(db, 0, DB_Empty)
1711       ){
1712         for(pEnc=&encnames[0]; pEnc->zName; pEnc++){
1713           if( 0==sqlite3StrICmp(zRight, pEnc->zName) ){
1714             SCHEMA_ENC(db) = ENC(db) =
1715                 pEnc->enc ? pEnc->enc : SQLITE_UTF16NATIVE;
1716             break;
1717           }
1718         }
1719         if( !pEnc->zName ){
1720           sqlite3ErrorMsg(pParse, "unsupported encoding: %s", zRight);
1721         }
1722       }
1723     }
1724   }
1725   break;
1726 #endif /* SQLITE_OMIT_UTF16 */
1727 
1728 #ifndef SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS
1729   /*
1730   **   PRAGMA [schema.]schema_version
1731   **   PRAGMA [schema.]schema_version = <integer>
1732   **
1733   **   PRAGMA [schema.]user_version
1734   **   PRAGMA [schema.]user_version = <integer>
1735   **
1736   **   PRAGMA [schema.]freelist_count
1737   **
1738   **   PRAGMA [schema.]data_version
1739   **
1740   **   PRAGMA [schema.]application_id
1741   **   PRAGMA [schema.]application_id = <integer>
1742   **
1743   ** The pragma's schema_version and user_version are used to set or get
1744   ** the value of the schema-version and user-version, respectively. Both
1745   ** the schema-version and the user-version are 32-bit signed integers
1746   ** stored in the database header.
1747   **
1748   ** The schema-cookie is usually only manipulated internally by SQLite. It
1749   ** is incremented by SQLite whenever the database schema is modified (by
1750   ** creating or dropping a table or index). The schema version is used by
1751   ** SQLite each time a query is executed to ensure that the internal cache
1752   ** of the schema used when compiling the SQL query matches the schema of
1753   ** the database against which the compiled query is actually executed.
1754   ** Subverting this mechanism by using "PRAGMA schema_version" to modify
1755   ** the schema-version is potentially dangerous and may lead to program
1756   ** crashes or database corruption. Use with caution!
1757   **
1758   ** The user-version is not used internally by SQLite. It may be used by
1759   ** applications for any purpose.
1760   */
1761   case PragTyp_HEADER_VALUE: {
1762     int iCookie = pPragma->iArg;  /* Which cookie to read or write */
1763     sqlite3VdbeUsesBtree(v, iDb);
1764     if( zRight && (pPragma->mPragFlg & PragFlg_ReadOnly)==0 ){
1765       /* Write the specified cookie value */
1766       static const VdbeOpList setCookie[] = {
1767         { OP_Transaction,    0,  1,  0},    /* 0 */
1768         { OP_SetCookie,      0,  0,  0},    /* 1 */
1769       };
1770       VdbeOp *aOp;
1771       sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(setCookie));
1772       aOp = sqlite3VdbeAddOpList(v, ArraySize(setCookie), setCookie, 0);
1773       if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
1774       aOp[0].p1 = iDb;
1775       aOp[1].p1 = iDb;
1776       aOp[1].p2 = iCookie;
1777       aOp[1].p3 = sqlite3Atoi(zRight);
1778     }else{
1779       /* Read the specified cookie value */
1780       static const VdbeOpList readCookie[] = {
1781         { OP_Transaction,     0,  0,  0},    /* 0 */
1782         { OP_ReadCookie,      0,  1,  0},    /* 1 */
1783         { OP_ResultRow,       1,  1,  0}
1784       };
1785       VdbeOp *aOp;
1786       sqlite3VdbeVerifyNoMallocRequired(v, ArraySize(readCookie));
1787       aOp = sqlite3VdbeAddOpList(v, ArraySize(readCookie),readCookie,0);
1788       if( ONLY_IF_REALLOC_STRESS(aOp==0) ) break;
1789       aOp[0].p1 = iDb;
1790       aOp[1].p1 = iDb;
1791       aOp[1].p3 = iCookie;
1792       sqlite3VdbeReusable(v);
1793     }
1794   }
1795   break;
1796 #endif /* SQLITE_OMIT_SCHEMA_VERSION_PRAGMAS */
1797 
1798 #ifndef SQLITE_OMIT_COMPILEOPTION_DIAGS
1799   /*
1800   **   PRAGMA compile_options
1801   **
1802   ** Return the names of all compile-time options used in this build,
1803   ** one option per row.
1804   */
1805   case PragTyp_COMPILE_OPTIONS: {
1806     int i = 0;
1807     const char *zOpt;
1808     pParse->nMem = 1;
1809     while( (zOpt = sqlite3_compileoption_get(i++))!=0 ){
1810       sqlite3VdbeLoadString(v, 1, zOpt);
1811       sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 1);
1812     }
1813     sqlite3VdbeReusable(v);
1814   }
1815   break;
1816 #endif /* SQLITE_OMIT_COMPILEOPTION_DIAGS */
1817 
1818 #ifndef SQLITE_OMIT_WAL
1819   /*
1820   **   PRAGMA [schema.]wal_checkpoint = passive|full|restart|truncate
1821   **
1822   ** Checkpoint the database.
1823   */
1824   case PragTyp_WAL_CHECKPOINT: {
1825     int iBt = (pId2->z?iDb:SQLITE_MAX_ATTACHED);
1826     int eMode = SQLITE_CHECKPOINT_PASSIVE;
1827     if( zRight ){
1828       if( sqlite3StrICmp(zRight, "full")==0 ){
1829         eMode = SQLITE_CHECKPOINT_FULL;
1830       }else if( sqlite3StrICmp(zRight, "restart")==0 ){
1831         eMode = SQLITE_CHECKPOINT_RESTART;
1832       }else if( sqlite3StrICmp(zRight, "truncate")==0 ){
1833         eMode = SQLITE_CHECKPOINT_TRUNCATE;
1834       }
1835     }
1836     pParse->nMem = 3;
1837     sqlite3VdbeAddOp3(v, OP_Checkpoint, iBt, eMode, 1);
1838     sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 3);
1839   }
1840   break;
1841 
1842   /*
1843   **   PRAGMA wal_autocheckpoint
1844   **   PRAGMA wal_autocheckpoint = N
1845   **
1846   ** Configure a database connection to automatically checkpoint a database
1847   ** after accumulating N frames in the log. Or query for the current value
1848   ** of N.
1849   */
1850   case PragTyp_WAL_AUTOCHECKPOINT: {
1851     if( zRight ){
1852       sqlite3_wal_autocheckpoint(db, sqlite3Atoi(zRight));
1853     }
1854     returnSingleInt(v,
1855        db->xWalCallback==sqlite3WalDefaultHook ?
1856            SQLITE_PTR_TO_INT(db->pWalArg) : 0);
1857   }
1858   break;
1859 #endif
1860 
1861   /*
1862   **  PRAGMA shrink_memory
1863   **
1864   ** IMPLEMENTATION-OF: R-23445-46109 This pragma causes the database
1865   ** connection on which it is invoked to free up as much memory as it
1866   ** can, by calling sqlite3_db_release_memory().
1867   */
1868   case PragTyp_SHRINK_MEMORY: {
1869     sqlite3_db_release_memory(db);
1870     break;
1871   }
1872 
1873   /*
1874   **  PRAGMA optimize
1875   **  PRAGMA optimize(MASK)
1876   **  PRAGMA schema.optimize
1877   **  PRAGMA schema.optimize(MASK)
1878   **
1879   ** Attempt to optimize the database.  All schemas are optimized in the first
1880   ** two forms, and only the specified schema is optimized in the latter two.
1881   **
1882   ** The details of optimizations performed by this pragma are expected
1883   ** to change and improve over time.  Applications should anticipate that
1884   ** this pragma will perform new optimizations in future releases.
1885   **
1886   ** The optional argument is a bitmask of optimizations to perform:
1887   **
1888   **    0x0001    Debugging mode.  Do not actually perform any optimizations
1889   **              but instead return one line of text for each optimization
1890   **              that would have been done.  Off by default.
1891   **
1892   **    0x0002    Run ANALYZE on tables that might benefit.  On by default.
1893   **              See below for additional information.
1894   **
1895   **    0x0004    (Not yet implemented) Record usage and performance
1896   **              information from the current session in the
1897   **              database file so that it will be available to "optimize"
1898   **              pragmas run by future database connections.
1899   **
1900   **    0x0008    (Not yet implemented) Create indexes that might have
1901   **              been helpful to recent queries
1902   **
1903   ** The default MASK is and always shall be 0xfffe.  0xfffe means perform all    ** of the optimizations listed above except Debug Mode, including new
1904   ** optimizations that have not yet been invented.  If new optimizations are
1905   ** ever added that should be off by default, those off-by-default
1906   ** optimizations will have bitmasks of 0x10000 or larger.
1907   **
1908   ** DETERMINATION OF WHEN TO RUN ANALYZE
1909   **
1910   ** In the current implementation, a table is analyzed if only if all of
1911   ** the following are true:
1912   **
1913   ** (1) MASK bit 0x02 is set.
1914   **
1915   ** (2) The query planner used sqlite_stat1-style statistics for one or
1916   **     more indexes of the table at some point during the lifetime of
1917   **     the current connection.
1918   **
1919   ** (3) One or more indexes of the table are currently unanalyzed OR
1920   **     the number of rows in the table has increased by 25 times or more
1921   **     since the last time ANALYZE was run.
1922   **
1923   ** The rules for when tables are analyzed are likely to change in
1924   ** future releases.
1925   */
1926   case PragTyp_OPTIMIZE: {
1927     int iDbLast;           /* Loop termination point for the schema loop */
1928     int iTabCur;           /* Cursor for a table whose size needs checking */
1929     HashElem *k;           /* Loop over tables of a schema */
1930     Schema *pSchema;       /* The current schema */
1931     Table *pTab;           /* A table in the schema */
1932     Index *pIdx;           /* An index of the table */
1933     LogEst szThreshold;    /* Size threshold above which reanalysis is needd */
1934     char *zSubSql;         /* SQL statement for the OP_SqlExec opcode */
1935     u32 opMask;            /* Mask of operations to perform */
1936 
1937     if( zRight ){
1938       opMask = (u32)sqlite3Atoi(zRight);
1939       if( (opMask & 0x02)==0 ) break;
1940     }else{
1941       opMask = 0xfffe;
1942     }
1943     iTabCur = pParse->nTab++;
1944     for(iDbLast = zDb?iDb:db->nDb-1; iDb<=iDbLast; iDb++){
1945       if( iDb==1 ) continue;
1946       sqlite3CodeVerifySchema(pParse, iDb);
1947       pSchema = db->aDb[iDb].pSchema;
1948       for(k=sqliteHashFirst(&pSchema->tblHash); k; k=sqliteHashNext(k)){
1949         pTab = (Table*)sqliteHashData(k);
1950 
1951         /* If table pTab has not been used in a way that would benefit from
1952         ** having analysis statistics during the current session, then skip it.
1953         ** This also has the effect of skipping virtual tables and views */
1954         if( (pTab->tabFlags & TF_StatsUsed)==0 ) continue;
1955 
1956         /* Reanalyze if the table is 25 times larger than the last analysis */
1957         szThreshold = pTab->nRowLogEst + 46; assert( sqlite3LogEst(25)==46 );
1958         for(pIdx=pTab->pIndex; pIdx; pIdx=pIdx->pNext){
1959           if( !pIdx->hasStat1 ){
1960             szThreshold = 0; /* Always analyze if any index lacks statistics */
1961             break;
1962           }
1963         }
1964         if( szThreshold ){
1965           sqlite3OpenTable(pParse, iTabCur, iDb, pTab, OP_OpenRead);
1966           sqlite3VdbeAddOp3(v, OP_IfSmaller, iTabCur,
1967                          sqlite3VdbeCurrentAddr(v)+2+(opMask&1), szThreshold);
1968           VdbeCoverage(v);
1969         }
1970         zSubSql = sqlite3MPrintf(db, "ANALYZE \"%w\".\"%w\"",
1971                                  db->aDb[iDb].zDbSName, pTab->zName);
1972         if( opMask & 0x01 ){
1973           int r1 = sqlite3GetTempReg(pParse);
1974           sqlite3VdbeAddOp4(v, OP_String8, 0, r1, 0, zSubSql, P4_DYNAMIC);
1975           sqlite3VdbeAddOp2(v, OP_ResultRow, r1, 1);
1976         }else{
1977           sqlite3VdbeAddOp4(v, OP_SqlExec, 0, 0, 0, zSubSql, P4_DYNAMIC);
1978         }
1979       }
1980     }
1981     sqlite3VdbeAddOp0(v, OP_Expire);
1982     break;
1983   }
1984 
1985   /*
1986   **   PRAGMA busy_timeout
1987   **   PRAGMA busy_timeout = N
1988   **
1989   ** Call sqlite3_busy_timeout(db, N).  Return the current timeout value
1990   ** if one is set.  If no busy handler or a different busy handler is set
1991   ** then 0 is returned.  Setting the busy_timeout to 0 or negative
1992   ** disables the timeout.
1993   */
1994   /*case PragTyp_BUSY_TIMEOUT*/ default: {
1995     assert( pPragma->ePragTyp==PragTyp_BUSY_TIMEOUT );
1996     if( zRight ){
1997       sqlite3_busy_timeout(db, sqlite3Atoi(zRight));
1998     }
1999     returnSingleInt(v, db->busyTimeout);
2000     break;
2001   }
2002 
2003   /*
2004   **   PRAGMA soft_heap_limit
2005   **   PRAGMA soft_heap_limit = N
2006   **
2007   ** IMPLEMENTATION-OF: R-26343-45930 This pragma invokes the
2008   ** sqlite3_soft_heap_limit64() interface with the argument N, if N is
2009   ** specified and is a non-negative integer.
2010   ** IMPLEMENTATION-OF: R-64451-07163 The soft_heap_limit pragma always
2011   ** returns the same integer that would be returned by the
2012   ** sqlite3_soft_heap_limit64(-1) C-language function.
2013   */
2014   case PragTyp_SOFT_HEAP_LIMIT: {
2015     sqlite3_int64 N;
2016     if( zRight && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK ){
2017       sqlite3_soft_heap_limit64(N);
2018     }
2019     returnSingleInt(v, sqlite3_soft_heap_limit64(-1));
2020     break;
2021   }
2022 
2023   /*
2024   **   PRAGMA threads
2025   **   PRAGMA threads = N
2026   **
2027   ** Configure the maximum number of worker threads.  Return the new
2028   ** maximum, which might be less than requested.
2029   */
2030   case PragTyp_THREADS: {
2031     sqlite3_int64 N;
2032     if( zRight
2033      && sqlite3DecOrHexToI64(zRight, &N)==SQLITE_OK
2034      && N>=0
2035     ){
2036       sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, (int)(N&0x7fffffff));
2037     }
2038     returnSingleInt(v, sqlite3_limit(db, SQLITE_LIMIT_WORKER_THREADS, -1));
2039     break;
2040   }
2041 
2042 #if defined(SQLITE_DEBUG) || defined(SQLITE_TEST)
2043   /*
2044   ** Report the current state of file logs for all databases
2045   */
2046   case PragTyp_LOCK_STATUS: {
2047     static const char *const azLockName[] = {
2048       "unlocked", "shared", "reserved", "pending", "exclusive"
2049     };
2050     int i;
2051     pParse->nMem = 2;
2052     for(i=0; i<db->nDb; i++){
2053       Btree *pBt;
2054       const char *zState = "unknown";
2055       int j;
2056       if( db->aDb[i].zDbSName==0 ) continue;
2057       pBt = db->aDb[i].pBt;
2058       if( pBt==0 || sqlite3BtreePager(pBt)==0 ){
2059         zState = "closed";
2060       }else if( sqlite3_file_control(db, i ? db->aDb[i].zDbSName : 0,
2061                                      SQLITE_FCNTL_LOCKSTATE, &j)==SQLITE_OK ){
2062          zState = azLockName[j];
2063       }
2064       sqlite3VdbeMultiLoad(v, 1, "ss", db->aDb[i].zDbSName, zState);
2065       sqlite3VdbeAddOp2(v, OP_ResultRow, 1, 2);
2066     }
2067     break;
2068   }
2069 #endif
2070 
2071 #ifdef SQLITE_HAS_CODEC
2072   case PragTyp_KEY: {
2073     if( zRight ) sqlite3_key_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
2074     break;
2075   }
2076   case PragTyp_REKEY: {
2077     if( zRight ) sqlite3_rekey_v2(db, zDb, zRight, sqlite3Strlen30(zRight));
2078     break;
2079   }
2080   case PragTyp_HEXKEY: {
2081     if( zRight ){
2082       u8 iByte;
2083       int i;
2084       char zKey[40];
2085       for(i=0, iByte=0; i<sizeof(zKey)*2 && sqlite3Isxdigit(zRight[i]); i++){
2086         iByte = (iByte<<4) + sqlite3HexToInt(zRight[i]);
2087         if( (i&1)!=0 ) zKey[i/2] = iByte;
2088       }
2089       if( (zLeft[3] & 0xf)==0xb ){
2090         sqlite3_key_v2(db, zDb, zKey, i/2);
2091       }else{
2092         sqlite3_rekey_v2(db, zDb, zKey, i/2);
2093       }
2094     }
2095     break;
2096   }
2097 #endif
2098 #if defined(SQLITE_HAS_CODEC) || defined(SQLITE_ENABLE_CEROD)
2099   case PragTyp_ACTIVATE_EXTENSIONS: if( zRight ){
2100 #ifdef SQLITE_HAS_CODEC
2101     if( sqlite3StrNICmp(zRight, "see-", 4)==0 ){
2102       sqlite3_activate_see(&zRight[4]);
2103     }
2104 #endif
2105 #ifdef SQLITE_ENABLE_CEROD
2106     if( sqlite3StrNICmp(zRight, "cerod-", 6)==0 ){
2107       sqlite3_activate_cerod(&zRight[6]);
2108     }
2109 #endif
2110   }
2111   break;
2112 #endif
2113 
2114   } /* End of the PRAGMA switch */
2115 
2116   /* The following block is a no-op unless SQLITE_DEBUG is defined. Its only
2117   ** purpose is to execute assert() statements to verify that if the
2118   ** PragFlg_NoColumns1 flag is set and the caller specified an argument
2119   ** to the PRAGMA, the implementation has not added any OP_ResultRow
2120   ** instructions to the VM.  */
2121   if( (pPragma->mPragFlg & PragFlg_NoColumns1) && zRight ){
2122     sqlite3VdbeVerifyNoResultRow(v);
2123   }
2124 
2125 pragma_out:
2126   sqlite3DbFree(db, zLeft);
2127   sqlite3DbFree(db, zRight);
2128 }
2129 #ifndef SQLITE_OMIT_VIRTUALTABLE
2130 /*****************************************************************************
2131 ** Implementation of an eponymous virtual table that runs a pragma.
2132 **
2133 */
2134 typedef struct PragmaVtab PragmaVtab;
2135 typedef struct PragmaVtabCursor PragmaVtabCursor;
2136 struct PragmaVtab {
2137   sqlite3_vtab base;        /* Base class.  Must be first */
2138   sqlite3 *db;              /* The database connection to which it belongs */
2139   const PragmaName *pName;  /* Name of the pragma */
2140   u8 nHidden;               /* Number of hidden columns */
2141   u8 iHidden;               /* Index of the first hidden column */
2142 };
2143 struct PragmaVtabCursor {
2144   sqlite3_vtab_cursor base; /* Base class.  Must be first */
2145   sqlite3_stmt *pPragma;    /* The pragma statement to run */
2146   sqlite_int64 iRowid;      /* Current rowid */
2147   char *azArg[2];           /* Value of the argument and schema */
2148 };
2149 
2150 /*
2151 ** Pragma virtual table module xConnect method.
2152 */
2153 static int pragmaVtabConnect(
2154   sqlite3 *db,
2155   void *pAux,
2156   int argc, const char *const*argv,
2157   sqlite3_vtab **ppVtab,
2158   char **pzErr
2159 ){
2160   const PragmaName *pPragma = (const PragmaName*)pAux;
2161   PragmaVtab *pTab = 0;
2162   int rc;
2163   int i, j;
2164   char cSep = '(';
2165   StrAccum acc;
2166   char zBuf[200];
2167 
2168   UNUSED_PARAMETER(argc);
2169   UNUSED_PARAMETER(argv);
2170   sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
2171   sqlite3StrAccumAppendAll(&acc, "CREATE TABLE x");
2172   for(i=0, j=pPragma->iPragCName; i<pPragma->nPragCName; i++, j++){
2173     sqlite3XPrintf(&acc, "%c\"%s\"", cSep, pragCName[j]);
2174     cSep = ',';
2175   }
2176   if( i==0 ){
2177     sqlite3XPrintf(&acc, "(\"%s\"", pPragma->zName);
2178     cSep = ',';
2179     i++;
2180   }
2181   j = 0;
2182   if( pPragma->mPragFlg & PragFlg_Result1 ){
2183     sqlite3StrAccumAppendAll(&acc, ",arg HIDDEN");
2184     j++;
2185   }
2186   if( pPragma->mPragFlg & (PragFlg_SchemaOpt|PragFlg_SchemaReq) ){
2187     sqlite3StrAccumAppendAll(&acc, ",schema HIDDEN");
2188     j++;
2189   }
2190   sqlite3StrAccumAppend(&acc, ")", 1);
2191   sqlite3StrAccumFinish(&acc);
2192   assert( strlen(zBuf) < sizeof(zBuf)-1 );
2193   rc = sqlite3_declare_vtab(db, zBuf);
2194   if( rc==SQLITE_OK ){
2195     pTab = (PragmaVtab*)sqlite3_malloc(sizeof(PragmaVtab));
2196     if( pTab==0 ){
2197       rc = SQLITE_NOMEM;
2198     }else{
2199       memset(pTab, 0, sizeof(PragmaVtab));
2200       pTab->pName = pPragma;
2201       pTab->db = db;
2202       pTab->iHidden = i;
2203       pTab->nHidden = j;
2204     }
2205   }else{
2206     *pzErr = sqlite3_mprintf("%s", sqlite3_errmsg(db));
2207   }
2208 
2209   *ppVtab = (sqlite3_vtab*)pTab;
2210   return rc;
2211 }
2212 
2213 /*
2214 ** Pragma virtual table module xDisconnect method.
2215 */
2216 static int pragmaVtabDisconnect(sqlite3_vtab *pVtab){
2217   PragmaVtab *pTab = (PragmaVtab*)pVtab;
2218   sqlite3_free(pTab);
2219   return SQLITE_OK;
2220 }
2221 
2222 /* Figure out the best index to use to search a pragma virtual table.
2223 **
2224 ** There are not really any index choices.  But we want to encourage the
2225 ** query planner to give == constraints on as many hidden parameters as
2226 ** possible, and especially on the first hidden parameter.  So return a
2227 ** high cost if hidden parameters are unconstrained.
2228 */
2229 static int pragmaVtabBestIndex(sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo){
2230   PragmaVtab *pTab = (PragmaVtab*)tab;
2231   const struct sqlite3_index_constraint *pConstraint;
2232   int i, j;
2233   int seen[2];
2234 
2235   pIdxInfo->estimatedCost = (double)1;
2236   if( pTab->nHidden==0 ){ return SQLITE_OK; }
2237   pConstraint = pIdxInfo->aConstraint;
2238   seen[0] = 0;
2239   seen[1] = 0;
2240   for(i=0; i<pIdxInfo->nConstraint; i++, pConstraint++){
2241     if( pConstraint->usable==0 ) continue;
2242     if( pConstraint->op!=SQLITE_INDEX_CONSTRAINT_EQ ) continue;
2243     if( pConstraint->iColumn < pTab->iHidden ) continue;
2244     j = pConstraint->iColumn - pTab->iHidden;
2245     assert( j < 2 );
2246     seen[j] = i+1;
2247   }
2248   if( seen[0]==0 ){
2249     pIdxInfo->estimatedCost = (double)2147483647;
2250     pIdxInfo->estimatedRows = 2147483647;
2251     return SQLITE_OK;
2252   }
2253   j = seen[0]-1;
2254   pIdxInfo->aConstraintUsage[j].argvIndex = 1;
2255   pIdxInfo->aConstraintUsage[j].omit = 1;
2256   if( seen[1]==0 ) return SQLITE_OK;
2257   pIdxInfo->estimatedCost = (double)20;
2258   pIdxInfo->estimatedRows = 20;
2259   j = seen[1]-1;
2260   pIdxInfo->aConstraintUsage[j].argvIndex = 2;
2261   pIdxInfo->aConstraintUsage[j].omit = 1;
2262   return SQLITE_OK;
2263 }
2264 
2265 /* Create a new cursor for the pragma virtual table */
2266 static int pragmaVtabOpen(sqlite3_vtab *pVtab, sqlite3_vtab_cursor **ppCursor){
2267   PragmaVtabCursor *pCsr;
2268   pCsr = (PragmaVtabCursor*)sqlite3_malloc(sizeof(*pCsr));
2269   if( pCsr==0 ) return SQLITE_NOMEM;
2270   memset(pCsr, 0, sizeof(PragmaVtabCursor));
2271   pCsr->base.pVtab = pVtab;
2272   *ppCursor = &pCsr->base;
2273   return SQLITE_OK;
2274 }
2275 
2276 /* Clear all content from pragma virtual table cursor. */
2277 static void pragmaVtabCursorClear(PragmaVtabCursor *pCsr){
2278   int i;
2279   sqlite3_finalize(pCsr->pPragma);
2280   pCsr->pPragma = 0;
2281   for(i=0; i<ArraySize(pCsr->azArg); i++){
2282     sqlite3_free(pCsr->azArg[i]);
2283     pCsr->azArg[i] = 0;
2284   }
2285 }
2286 
2287 /* Close a pragma virtual table cursor */
2288 static int pragmaVtabClose(sqlite3_vtab_cursor *cur){
2289   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)cur;
2290   pragmaVtabCursorClear(pCsr);
2291   sqlite3_free(pCsr);
2292   return SQLITE_OK;
2293 }
2294 
2295 /* Advance the pragma virtual table cursor to the next row */
2296 static int pragmaVtabNext(sqlite3_vtab_cursor *pVtabCursor){
2297   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2298   int rc = SQLITE_OK;
2299 
2300   /* Increment the xRowid value */
2301   pCsr->iRowid++;
2302   assert( pCsr->pPragma );
2303   if( SQLITE_ROW!=sqlite3_step(pCsr->pPragma) ){
2304     rc = sqlite3_finalize(pCsr->pPragma);
2305     pCsr->pPragma = 0;
2306     pragmaVtabCursorClear(pCsr);
2307   }
2308   return rc;
2309 }
2310 
2311 /*
2312 ** Pragma virtual table module xFilter method.
2313 */
2314 static int pragmaVtabFilter(
2315   sqlite3_vtab_cursor *pVtabCursor,
2316   int idxNum, const char *idxStr,
2317   int argc, sqlite3_value **argv
2318 ){
2319   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2320   PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
2321   int rc;
2322   int i, j;
2323   StrAccum acc;
2324   char *zSql;
2325 
2326   UNUSED_PARAMETER(idxNum);
2327   UNUSED_PARAMETER(idxStr);
2328   pragmaVtabCursorClear(pCsr);
2329   j = (pTab->pName->mPragFlg & PragFlg_Result1)!=0 ? 0 : 1;
2330   for(i=0; i<argc; i++, j++){
2331     assert( j<ArraySize(pCsr->azArg) );
2332     pCsr->azArg[j] = sqlite3_mprintf("%s", sqlite3_value_text(argv[i]));
2333     if( pCsr->azArg[j]==0 ){
2334       return SQLITE_NOMEM;
2335     }
2336   }
2337   sqlite3StrAccumInit(&acc, 0, 0, 0, pTab->db->aLimit[SQLITE_LIMIT_SQL_LENGTH]);
2338   sqlite3StrAccumAppendAll(&acc, "PRAGMA ");
2339   if( pCsr->azArg[1] ){
2340     sqlite3XPrintf(&acc, "%Q.", pCsr->azArg[1]);
2341   }
2342   sqlite3StrAccumAppendAll(&acc, pTab->pName->zName);
2343   if( pCsr->azArg[0] ){
2344     sqlite3XPrintf(&acc, "=%Q", pCsr->azArg[0]);
2345   }
2346   zSql = sqlite3StrAccumFinish(&acc);
2347   if( zSql==0 ) return SQLITE_NOMEM;
2348   rc = sqlite3_prepare_v2(pTab->db, zSql, -1, &pCsr->pPragma, 0);
2349   sqlite3_free(zSql);
2350   if( rc!=SQLITE_OK ){
2351     pTab->base.zErrMsg = sqlite3_mprintf("%s", sqlite3_errmsg(pTab->db));
2352     return rc;
2353   }
2354   return pragmaVtabNext(pVtabCursor);
2355 }
2356 
2357 /*
2358 ** Pragma virtual table module xEof method.
2359 */
2360 static int pragmaVtabEof(sqlite3_vtab_cursor *pVtabCursor){
2361   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2362   return (pCsr->pPragma==0);
2363 }
2364 
2365 /* The xColumn method simply returns the corresponding column from
2366 ** the PRAGMA.
2367 */
2368 static int pragmaVtabColumn(
2369   sqlite3_vtab_cursor *pVtabCursor,
2370   sqlite3_context *ctx,
2371   int i
2372 ){
2373   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2374   PragmaVtab *pTab = (PragmaVtab*)(pVtabCursor->pVtab);
2375   if( i<pTab->iHidden ){
2376     sqlite3_result_value(ctx, sqlite3_column_value(pCsr->pPragma, i));
2377   }else{
2378     sqlite3_result_text(ctx, pCsr->azArg[i-pTab->iHidden],-1,SQLITE_TRANSIENT);
2379   }
2380   return SQLITE_OK;
2381 }
2382 
2383 /*
2384 ** Pragma virtual table module xRowid method.
2385 */
2386 static int pragmaVtabRowid(sqlite3_vtab_cursor *pVtabCursor, sqlite_int64 *p){
2387   PragmaVtabCursor *pCsr = (PragmaVtabCursor*)pVtabCursor;
2388   *p = pCsr->iRowid;
2389   return SQLITE_OK;
2390 }
2391 
2392 /* The pragma virtual table object */
2393 static const sqlite3_module pragmaVtabModule = {
2394   0,                           /* iVersion */
2395   0,                           /* xCreate - create a table */
2396   pragmaVtabConnect,           /* xConnect - connect to an existing table */
2397   pragmaVtabBestIndex,         /* xBestIndex - Determine search strategy */
2398   pragmaVtabDisconnect,        /* xDisconnect - Disconnect from a table */
2399   0,                           /* xDestroy - Drop a table */
2400   pragmaVtabOpen,              /* xOpen - open a cursor */
2401   pragmaVtabClose,             /* xClose - close a cursor */
2402   pragmaVtabFilter,            /* xFilter - configure scan constraints */
2403   pragmaVtabNext,              /* xNext - advance a cursor */
2404   pragmaVtabEof,               /* xEof */
2405   pragmaVtabColumn,            /* xColumn - read data */
2406   pragmaVtabRowid,             /* xRowid - read data */
2407   0,                           /* xUpdate - write data */
2408   0,                           /* xBegin - begin transaction */
2409   0,                           /* xSync - sync transaction */
2410   0,                           /* xCommit - commit transaction */
2411   0,                           /* xRollback - rollback transaction */
2412   0,                           /* xFindFunction - function overloading */
2413   0,                           /* xRename - rename the table */
2414   0,                           /* xSavepoint */
2415   0,                           /* xRelease */
2416   0                            /* xRollbackTo */
2417 };
2418 
2419 /*
2420 ** Check to see if zTabName is really the name of a pragma.  If it is,
2421 ** then register an eponymous virtual table for that pragma and return
2422 ** a pointer to the Module object for the new virtual table.
2423 */
2424 Module *sqlite3PragmaVtabRegister(sqlite3 *db, const char *zName){
2425   const PragmaName *pName;
2426   assert( sqlite3_strnicmp(zName, "pragma_", 7)==0 );
2427   pName = pragmaLocate(zName+7);
2428   if( pName==0 ) return 0;
2429   if( (pName->mPragFlg & (PragFlg_Result0|PragFlg_Result1))==0 ) return 0;
2430   assert( sqlite3HashFind(&db->aModule, zName)==0 );
2431   return sqlite3VtabCreateModule(db, zName, &pragmaVtabModule, (void*)pName, 0);
2432 }
2433 
2434 #endif /* SQLITE_OMIT_VIRTUALTABLE */
2435 
2436 #endif /* SQLITE_OMIT_PRAGMA */
2437