*** DRAFT ***
The PRAGMA statement is an SQL extension specific to SQLite and used to modify the operation of the SQLite library or to query the SQLite library for internal (non-table) data. The PRAGMA statement is issued using the same interface as other SQLite commands (e.g. SELECT, INSERT) but is different in the following important respects:
The C-language API for SQLite provides the SQLITE_FCNTL_PRAGMA file control which gives VFS implementations the opportunity to add new PRAGMA statements or to override the meaning of built-in PRAGMA statements.
R-64973-09381:[A pragma can take either zero or one argument. ] R-60831-05341:[The argument is may be either in parentheses or it may be separated from the pragma name by an equal sign. ] R-04709-28430:[The two syntaxes yield identical results. ] R-36822-49898:[In many pragmas, the argument is a boolean. The boolean can be one of:
R-15737-42560:[Keyword arguments can optionally appear in quotes. ] (Example: 'yes' [FALSE].) Some pragmas takes a string literal as their argument. When pragma takes a keyword argument, it will usually also take a numeric equivalent as well. For example, "0" and "no" mean the same thing, as does "1" and "yes". When querying the value of a setting, many pragmas return the number rather than the keyword.
R-63043-31985:[A pragma may have an optional schema-name before the pragma name. ] R-46762-41357:[The schema-name is the name of an ATTACH-ed database or "main" or "temp" for the main and the TEMP databases. ] R-45642-41863:[If the optional schema name is omitted, "main" is assumed. ] R-37137-45553:[In some pragmas, the schema name is meaningless and is simply ignored. ] In the documentation below, pragmas for which the schema name is meaningful are shown with a "schema." prefix.
PRAGMAs that return results and that have no side-effects can be accessed from ordinary SELECT statements as table-valued functions. For each participating PRAGMA, the corresponding table-valued function has the same name as the PRAGMA with a 7-character "pragma_" prefix. The PRAGMA argument and schema, if any, are passed as arguments to the table-valued function, with the schema as an optional, last argument.
For example, information about the columns in an index can be read using the index_info pragma as follows:
PRAGMA index_info('idx52');
Or, the same content can be read using:
SELECT * FROM pragma_index_info('idx52');
The advantage of the table-valued function format is that the query can return just a subset of the PRAGMA columns, can include a WHERE clause, can use aggregate functions, and the table-valued function can be just one of several data sources in a join. For example, to get a list of all indexed columns in a schema, one could query:
SELECT DISTINCT m.name || '.' || ii.name AS 'indexed-columns'
FROM sqlite_schema AS m,
pragma_index_list(m.name) AS il,
pragma_index_info(il.name) AS ii
WHERE m.type='table'
ORDER BY 1;
Additional notes:
Table-valued functions exist only for built-in PRAGMAs, not for PRAGMAs defined using the SQLITE_FCNTL_PRAGMA file control.
Table-valued functions exist only for PRAGMAs that return results and that have no side-effects.
This feature could be used to implement information schema by first creating a separate schema using
Then creating VIEWs in that schema that implement the official information schema tables using table-valued PRAGMA functions.ATTACH ':memory:' AS 'information_schema';
The table-valued functions for PRAGMA feature was added in SQLite version 3.16.0 (2017-01-02). Prior versions of SQLite cannot use this feature.
Notes:
R-26022-39063:[PRAGMA analysis_limit;
PRAGMA analysis_limit = N;
R-27308-47543:[Query or change a limit on the approximate ANALYZE setting. This is the approximate number of rows examined in each index by the ANALYZE command. ] R-55089-42193:[If the argument N is omitted, then the analysis limit is unchanged. ] R-64444-28602:[If the limit is zero, then the analysis limit is disabled and the ANALYZE command will examine all rows of each index. ] R-42714-29052:[If N is greater than zero, then the analysis limit is set to N and subsequent ANALYZE commands will stop analyzing each index after it has examined approximately N rows. ] R-40975-20399:[If N is a negative number or something other than an integer value, then the pragma behaves as if the N argument was omitted. ] R-57594-65522:[In all cases, the value returned is the new analysis limit used for subsequent ANALYZE commands. ]
This pragma can be used to help the ANALYZE command run faster on large databases. The results of analysis are not as good when only part of each index is examined, but the results are usually good enough. Setting N to 100 or 1000 allows the ANALYZE command to run very quickly, even on multi-gigabyte database files. This pragma is particularly useful in combination with PRAGMA optimize.
This pragma was added in SQLite version 3.32.0 (2020-05-22). R-42924-00638:[The current implementation only uses the lower 31 bits of the N value - higher order bits are silently ignored. Future versions of SQLite might begin using higher order bits. ]
PRAGMA schema.application_id;
PRAGMA schema.application_id = integer ;
R-60755-45226:[The application_id PRAGMA is used to query or set the 32-bit signed big-endian "Application ID" integer located at offset 68 into the database header. ] Applications that use SQLite as their application file-format should set the Application ID integer to a unique integer so that utilities such as file(1) can determine the specific file type rather than just reporting "SQLite3 Database". A list of assigned application IDs can be seen by consulting the magic.txt file in the SQLite source repository.
See also the user_version pragma.
PRAGMA schema.auto_vacuum;
PRAGMA schema.auto_vacuum =
0 | NONE | 1 | FULL | 2 | INCREMENTAL;
Query or set the auto-vacuum status in the database.
R-50578-26484:[The default setting for auto-vacuum is 0 or "none", unless the SQLITE_DEFAULT_AUTOVACUUM compile-time option is used. ] R-11896-08162:[The "none" setting means that auto-vacuum is disabled. ] R-12526-56546:[When auto-vacuum is disabled and data is deleted data from a database, the database file remains the same size. ] R-64629-22390:[Unused database file pages are added to a "freelist" and reused for subsequent inserts. ] So no database file space is lost. However, the database file does not shrink. R-43482-09713:[In this mode the VACUUM command can be used to rebuild the entire database file and thus reclaim unused disk space. ]
R-18500-08619:[When the auto-vacuum mode is 1 or "full", the freelist pages are moved to the end of the database file and the database file is truncated to remove the freelist pages at every transaction commit. ] R-57803-30267:[Note, however, that auto-vacuum only truncates the freelist pages from the file. Auto-vacuum does not defragment the database nor repack individual database pages the way that the VACUUM command does. ] In fact, because it moves pages around within the file, auto-vacuum can actually make fragmentation worse.
Auto-vacuuming is only possible if the database stores some additional information that allows each database page to be traced backwards to its referrer. R-40212-32858:[Therefore, auto-vacuuming must be turned on before any tables are created. ] It is not possible to enable or disable auto-vacuum after a table has been created.
R-24519-28304:[When the value of auto-vacuum is 2 or "incremental" then the additional information needed to do auto-vacuuming is stored in the database file but auto-vacuuming does not occur automatically at each commit as it does with auto_vacuum=full. ] R-15909-61171:[In incremental mode, the separate incremental_vacuum pragma must be invoked to cause the auto-vacuum to occur. ]
R-25616-61116:[The database connection can be changed between full and incremental autovacuum mode at any time. ] R-03934-63400:[However, changing from "none" to "full" or "incremental" can only occur when the database is new (no tables have yet been created) or by running the VACUUM command. ] R-03040-34580:[To change auto-vacuum modes, first use the auto_vacuum pragma to set the new desired mode, then invoke the VACUUM command to reorganize the entire database file. ] R-62740-39384:[To change from "full" or "incremental" back to "none" always requires running VACUUM even on an empty database. ]
R-48932-13175:[When the auto_vacuum pragma is invoked with no arguments, it returns the current auto_vacuum mode. ]
R-34271-33106:[PRAGMA automatic_index;
PRAGMA automatic_index = boolean;
Query, set, or clear the automatic indexing capability. ]
Automatic indexing is enabled by default as of version 3.7.17 (2013-05-20), but this might change in future releases of SQLite.
R-23579-05241:[PRAGMA busy_timeout;
PRAGMA busy_timeout = milliseconds;
Query or change the setting of the busy timeout. ] This pragma is an alternative to the sqlite3_busy_timeout() C-language interface which is made available as a pragma for use with language bindings that do not provide direct access to sqlite3_busy_timeout().
Each database connection can only have a single busy handler. This PRAGMA sets the busy handler for the process, possibly overwriting any previously set busy handler.
R-13861-56665:[PRAGMA schema.cache_size;
PRAGMA schema.cache_size = pages;
PRAGMA schema.cache_size = -kibibytes;
Query or change the suggested maximum number of database disk pages that SQLite will hold in memory at once per open database file. ] Whether or not this suggestion is honored is at the discretion of the Application Defined Page Cache. The default page cache that is built into SQLite honors the request, however alternative application-defined page cache implementations may choose to interpret the suggested cache size in different ways or to ignore it all together. R-30185-15359:[The default suggested cache size is -2000, which means the cache size is limited to 2048000 bytes of memory. ] R-48205-43578:[The default suggested cache size can be altered using the SQLITE_DEFAULT_CACHE_SIZE compile-time options. ] R-27461-16942:[The TEMP database has a default suggested cache size of 0 pages. ]
R-42059-47211:[If the argument N is positive then the suggested cache size is set to N. ] R-59858-46238:[If the argument N is negative, then the number of cache pages is adjusted to be a number of pages that would use approximately abs(N*1024) bytes of memory based on the current page size. ] SQLite remembers the number of pages in the page cache, not the amount of memory used. So if you set the cache size using a negative number and subsequently change the page size (using the PRAGMA page_size command) then the maximum amount of cache memory will go up or down in proportion to the change in page size.
Backwards compatibility note: The behavior of cache_size with a negative N was different prior to version 3.7.10 (2012-01-16). In earlier versions, the number of pages in the cache was set to the absolute value of N.
R-41134-27890:[When you change the cache size using the cache_size pragma, the change only endures for the current session. ] R-48331-62427:[The cache size reverts to the default value when the database is closed and reopened. ]
The default page cache implemention does not allocate the full amount of cache memory all at once. Cache memory is allocated in smaller chunks on an as-needed basis. The page_cache setting is a (suggested) upper bound on the amount of memory that the cache can use, not the amount of memory it will use all of the time. This is the behavior of the default page cache implementation, but an application defined page cache is free to behave differently if it wants.
R-63549-59887:[PRAGMA cache_spill;
PRAGMA cache_spill=boolean;
PRAGMA schema.cache_spill=N;
]
R-07634-40532:[The cache_spill pragma enables or disables the ability of the pager to spill dirty cache pages to the database file in the middle of a transaction. ] R-23955-02765:[Cache_spill is enabled by default ] and most applications should leave it that way as cache spilling is usually advantageous. However, a cache spill has the side-effect of acquiring an EXCLUSIVE lock on the database file. Hence, some applications that have large long-running transactions may want to disable cache spilling in order to prevent the application from acquiring an exclusive lock on the database until the moment that the transaction COMMITs.
R-34657-61226:[The "PRAGMA cache_spill=N" form of this pragma sets a minimum cache size threshold required for spilling to occur. ] R-30164-60316:[The number of pages in cache must exceed both the cache_spill threshold and the maximum cache size set by the PRAGMA cache_size statement in order for spilling to occur. ]
R-23786-28684:[The "PRAGMA cache_spill=boolean" form of this pragma applies across all databases attached to the database connection. ] R-22872-18005:[But the "PRAGMA cache_spill=N" form of this statement only applies to the "main" schema or whatever other schema is specified as part of the statement. ]
PRAGMA case_sensitive_like = boolean;
R-57216-60803:[The default behavior of the LIKE operator is to ignore case for ASCII characters. Hence, by default 'a' LIKE 'A' is true. ] R-34730-53445:[The case_sensitive_like pragma installs a new application-defined LIKE function that is either case sensitive or insensitive depending on the value of the case_sensitive_like pragma. ] R-06710-22511:[When case_sensitive_like is disabled, the default LIKE behavior is expressed. ] R-23019-08375:[When case_sensitive_like is enabled, case becomes significant. So, for example, 'a' LIKE 'A' is false but 'a' LIKE 'a' is still true. ]
R-54349-27488:[This pragma uses sqlite3_create_function() to overload the LIKE and GLOB functions, which may override previous implementations of LIKE and GLOB registered by the application. ] R-02597-60207:[This pragma only changes the behavior of the SQL LIKE operator. It does not change the behavior of the sqlite3_strlike() C-language interface, which is always case insensitive. ]
R-47085-17460:[PRAGMA cell_size_check
PRAGMA cell_size_check = boolean;
The cell_size_check pragma enables or disables additional sanity checking on database b-tree pages as they are initially read from disk. ] With cell size checking enabled, database corruption is detected earlier and is less likely to "spread". However, there is a small performance hit for doing the extra checks and so cell size checking is turned off by default.
R-59941-62933:[PRAGMA checkpoint_fullfsync
PRAGMA checkpoint_fullfsync = boolean;
Query or change the fullfsync flag for checkpoint operations. ] R-14970-42377:[If this flag is set, then the F_FULLFSYNC syncing method is used during checkpoint operations on systems that support F_FULLFSYNC. ] R-58560-23968:[The default value of the checkpoint_fullfsync flag is off. ] Only Mac OS-X supports F_FULLFSYNC.
R-48930-58522:[If the fullfsync flag is set, then the F_FULLFSYNC syncing method is used for all sync operations and the checkpoint_fullfsync setting is irrelevant. ]
R-08469-46782:[PRAGMA collation_list;
Return a list of the collating sequences defined for the current database connection.
]PRAGMA compile_options;
R-40541-16535:[This pragma returns the names of compile-time options used when building SQLite, one option per row. ] R-58101-01610:[The "SQLITE_" prefix is omitted from the returned option names. ] See also the sqlite3_compileoption_get() C/C++ interface and the sqlite_compileoption_get() SQL functions.
PRAGMA count_changes;
PRAGMA count_changes = boolean;
Query or change the count-changes flag. Normally, when the count-changes flag is not set, INSERT, UPDATE and DELETE statements return no data. When count-changes is set, each of these commands returns a single row of data consisting of one integer value - the number of rows inserted, modified or deleted by the command. The returned change count does not include any insertions, modifications or deletions performed by triggers, any changes made automatically by foreign key actions, or updates caused by an upsert.
Another way to get the row change counts is to use the sqlite3_changes() or sqlite3_total_changes() interfaces. There is a subtle different, though. When an INSERT, UPDATE, or DELETE is run against a view using an INSTEAD OF trigger, the count_changes pragma reports the number of rows in the view that fired the trigger, whereas sqlite3_changes() and sqlite3_total_changes() do not.
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
PRAGMA data_store_directory;
PRAGMA data_store_directory = 'directory-name';
Query or change the value of the sqlite3_data_directory global variable, which windows operating-system interface backends use to determine where to store database files specified using a relative pathname.
Changing the data_store_directory setting is not threadsafe. Never change the data_store_directory setting if another thread within the application is running any SQLite interface at the same time. Doing so results in undefined behavior. Changing the data_store_directory setting writes to the sqlite3_data_directory global variable and that global variable is not protected by a mutex.
This facility is provided for WinRT which does not have an OS mechanism for reading or changing the current working directory. The use of this pragma in any other context is discouraged and may be disallowed in future releases.
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
PRAGMA schema.data_version;
R-27726-60934:[The "PRAGMA data_version" command provides an indication that the database file has been modified. ] Interactive programs that hold database content in memory or that display database content on-screen can use the PRAGMA data_version command to determine if they need to flush and reload their memory or update the screen display.
R-63005-41812:[The integer values returned by two invocations of "PRAGMA data_version" from the same connection will be different if changes were committed to the database by any other connection in the interim. ] R-47505-58569:[The "PRAGMA data_version" value is unchanged for commits made on the same database connection. ] R-54562-06892:[The behavior of "PRAGMA data_version" is the same for all database connections, including database connections in separate processes and shared cache database connections. ]
R-19326-44825:[The "PRAGMA data_version" value is a local property of each database connection and so values returned by two concurrent invocations of "PRAGMA data_version" on separate database connections are often different even though the underlying database is identical. ] It is only meaningful to compare the "PRAGMA data_version" values returned by the same database connection at two different points in time.
R-57464-30285:[PRAGMA database_list;
This pragma works like a query to return one row for each database attached to the current database connection. ] R-49128-31170:[The second column is "main" for the main database file, "temp" for the database file used to store TEMP objects, or the name of the ATTACHed database for other database files. ] R-61005-38009:[The third column is the name of the database file itself, or an empty string if the database is not associated with a file. ]
This pragma queries or sets the suggested maximum number of pages of disk cache that will be allocated per open database file.
] R-52058-53560:[The difference between this pragma and cache_size is that the value set here persists across database connections. ] R-61141-39803:[The value of the default cache size is stored in the 4-byte big-endian integer located at offset 48 in the header of the database file. ]This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
PRAGMA defer_foreign_keys
PRAGMA defer_foreign_keys = boolean;
R-18981-16292:[When the defer_foreign_keys PRAGMA is on, enforcement of all foreign key constraints is delayed until the outermost transaction is committed. ] R-28911-57501:[The defer_foreign_keys pragma defaults to OFF so that foreign key constraints are only deferred if they are created as "DEFERRABLE INITIALLY DEFERRED". ] R-21752-26913:[The defer_foreign_keys pragma is automatically switched off at each COMMIT or ROLLBACK. Hence, the defer_foreign_keys pragma must be separately enabled for each transaction. ] This pragma is only meaningful if foreign key constraints are enabled, of course.
The sqlite3_db_status(db,SQLITE_DBSTATUS_DEFERRED_FKS,...) C-language interface can be used during a transaction to determine if there are deferred and unresolved foreign key constraints.
PRAGMA empty_result_callbacks;
PRAGMA empty_result_callbacks = boolean;
Query or change the empty-result-callbacks flag.
The empty-result-callbacks flag affects the sqlite3_exec() API only. Normally, when the empty-result-callbacks flag is cleared, the callback function supplied to the sqlite3_exec() is not invoked for commands that return zero rows of data. When empty-result-callbacks is set in this situation, the callback function is invoked exactly once, with the third parameter set to 0 (NULL). This is to enable programs that use the sqlite3_exec() API to retrieve column-names even when a query returns no data.
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
R-05688-29289:[PRAGMA encoding;
PRAGMA encoding = 'UTF-8';
PRAGMA encoding = 'UTF-16';
PRAGMA encoding = 'UTF-16le';
PRAGMA encoding = 'UTF-16be';
]
R-22504-36456:[In first form, if the main database has already been created, then this pragma returns the text encoding used by the main database, one of 'UTF-8', 'UTF-16le' (little-endian UTF-16 encoding) or 'UTF-16be' (big-endian UTF-16 encoding). ] R-47754-42489:[If the main database has not already been created, then the value returned is the text encoding that will be used to create the main database, if it is created by this session. ]
R-44382-28097:[The second through fifth forms of this pragma set the encoding that the main database will be created with if it is created by this session. ] R-56236-11699:[The string 'UTF-16' is interpreted as "UTF-16 encoding using native machine byte-ordering". ] R-39746-16618:[It is not possible to change the text encoding of a database after it has been created and any attempt to do so will be silently ignored. ]
R-16040-25925:[If no encoding is first set with this pragma, then the encoding with which the main database will be created defaults to one determined by the API used to open the connection. ]
R-37812-47407:[Once an encoding has been set for a database, it cannot be changed. ]
R-46702-22190:[Databases created by the ATTACH command always use the same encoding as the main database. ] R-09943-43999:[An attempt to ATTACH a database with a different text encoding from the "main" database will fail. ]
R-15402-03103:[PRAGMA schema.foreign_key_check;
PRAGMA schema.foreign_key_check(table-name);
]
R-41653-15278:[The foreign_key_check pragma checks the database, or the table called "table-name", for foreign key constraints that are violated. The foreign_key_check pragma returns one row output for each foreign key violation. ] R-45728-08709:[There are four columns in each result row. ] R-55672-01620:[The first column is the name of the table that contains the REFERENCES clause. ] R-00471-55166:[The second column is the rowid of the row that contains the invalid REFERENCES clause, or NULL if the child table is a WITHOUT ROWID table. ] R-40482-20265:[The third column is the name of the table that is referred to. ] R-62839-07969:[The fourth column is the index of the specific foreign key constraint that failed. ] R-31235-42643:[The fourth column in the output of the foreign_key_check pragma is the same integer as the first column in the output of the foreign_key_list pragma. ] R-29523-01234:[When a "table-name" is specified, the only foreign key constraints checked are those created by REFERENCES clauses in the CREATE TABLE statement for table-name. ]
R-12507-28763:[PRAGMA foreign_key_list(table-name);
This pragma returns one row for each foreign key constraint created by a REFERENCES clause in the CREATE TABLE statement of table "table-name". ]
R-18160-43138:[PRAGMA foreign_keys;
PRAGMA foreign_keys = boolean;
Query, set, or clear the enforcement of foreign key constraints. ]
R-53547-37067:[This pragma is a no-op within a transaction; foreign key constraint enforcement may only be enabled or disabled when there is no pending BEGIN or SAVEPOINT. ]
R-54105-45069:[Changing the foreign_keys setting affects the execution of all statements prepared using the database connection, including those prepared before the setting was changed. ] R-64276-00534:[Any existing statements prepared using the legacy sqlite3_prepare() interface may fail with an SQLITE_SCHEMA error after the foreign_keys setting is changed. ]
R-09033-01493:[As of SQLite version 3.6.19, the default setting for foreign key enforcement is OFF. ] However, that might change in a future release of SQLite. The default setting for foreign key enforcement can be specified at compile-time using the SQLITE_DEFAULT_FOREIGN_KEYS preprocessor macro. To minimize future problems, applications should set the foreign key enforcement flag as required by the application and not depend on the default setting.
R-11211-21323:[PRAGMA schema.freelist_count;
Return the number of unused pages in the database file. ]
PRAGMA full_column_names;
PRAGMA full_column_names = boolean;
Query or change the full_column_names flag. This flag together with the short_column_names flag determine the way SQLite assigns names to result columns of SELECT statements. Result columns are named by applying the following rules in order:
If there is an AS clause on the result, then the name of the column is the right-hand side of the AS clause.
If the result is a general expression, not a just the name of a source table column, then the name of the result is a copy of the expression text.
If the short_column_names pragma is ON, then the name of the result is the name of the source table column without the source table name prefix: COLUMN.
If both pragmas short_column_names and full_column_names are OFF then case (2) applies.
The name of the result column is a combination of the source table and source column name: TABLE.COLUMN
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
R-29353-26294:[PRAGMA fullfsync
PRAGMA fullfsync = boolean;
Query or change the fullfsync flag. ] R-09748-03241:[This flag determines whether or not the F_FULLFSYNC syncing method is used on systems that support it. ] R-30269-25284:[The default value of the fullfsync flag is off. ] Only Mac OS X supports F_FULLFSYNC.
See also checkpoint_fullfsync.
R-24539-09359:[PRAGMA function_list;
This pragma returns a list of SQL functions
known to the database connection.
PRAGMA hard_heap_limit
PRAGMA hard_heap_limit=N
R-06033-51812:[This pragma invokes the sqlite3_hard_heap_limit64() interface with the argument N, if N is specified and N is a positive integer that is less than the current hard heap limit. ] R-07358-23974:[The hard_heap_limit pragma always returns the same integer that would be returned by the sqlite3_hard_heap_limit64(-1) C-language function. ] R-09205-13964:[That is to say, it always returns the value of the hard heap limit that is set after any changes imposed by this PRAGMA. ]
This pragma can only lower the heap limit, never raise it. The C-language interface sqlite3_hard_heap_limit64() must be used to raise the heap limit.
See also the soft_heap_limit pragma.
R-23984-49501:[PRAGMA ignore_check_constraints = boolean;
This pragma enables or disables the enforcement of CHECK constraints. ] R-26888-26313:[The default setting is off, meaning that CHECK constraints are enforced by default. ]
PRAGMA schema.incremental_vacuum(N);
PRAGMA schema.incremental_vacuum;
The incremental_vacuum pragma causes up to N pages to be removed from the freelist.
] R-52155-58082:[The database file is truncated by the same amount. ] R-42333-10376:[The incremental_vacuum pragma has no effect if the database is not in auto_vacuum=incremental mode or if there are no pages on the freelist. ] R-63684-00056:[If there are fewer than N pages on the freelist, or if N is less than 1, or if the "(N)" argument is omitted, then the entire freelist is cleared. ]R-29448-60346:[PRAGMA schema.index_info(index-name);
This pragma returns one row for each key column in the named index. ] A key column is a column that is actually named in the CREATE INDEX index statement or UNIQUE constraint or PRIMARY KEY constraint that created the index. Index entries also usually contain auxiliary columns that point back to the table row being indexed. R-23114-21695:[The auxiliary index-columns are not shown by the index_info pragma, but they are listed by the index_xinfo pragma. ]
Output columns from the index_info pragma are as follows:
If there is no index named index-name but there is a WITHOUT ROWID table with that name, then (as of SQLite version 3.30.0 on 2019-10-04) this pragma returns the PRIMARY KEY columns of the WITHOUT ROWID table as they are used in the records of the underlying b-tree, which is to say with duplicate columns removed.
R-64103-17776:[PRAGMA schema.index_list(table-name);
This pragma returns one row for each index associated with the given table. ]
Output columns from the index_list pragma are as follows:
R-56143-29319:[PRAGMA schema.index_xinfo(index-name);
This pragma returns information about every column in an index. ] R-45970-35618:[Unlike this index_info pragma, this pragma returns information about every column in the index, not just the key columns. ] (A key column is a column that is actually named in the CREATE INDEX index statement or UNIQUE constraint or PRIMARY KEY constraint that created the index. Auxiliary columns are additional columns needed to locate the table entry that corresponds to each index entry.)
Output columns from the index_xinfo pragma are as follows:
If there is no index named index-name but there is a WITHOUT ROWID table with that name, then (as of SQLite version 3.30.0 on 2019-10-04) this pragma returns the columns of the WITHOUT ROWID table as they are used in the records of the underlying b-tree, which is to say with de-duplicated PRIMARY KEY columns first followed by data columns.
PRAGMA schema.integrity_check;
PRAGMA schema.integrity_check(N)
PRAGMA schema.integrity_check(TABLENAME)
R-55700-34343:[This pragma does a low-level formatting and consistency check
of the database.
]
R-50173-30557:[The integrity_check pragma look for:
]
R-05529-49311:[If the integrity_check pragma finds problems, strings are returned (as multiple rows with a single column per row) which describe the problems. ] R-41914-07968:[Pragma integrity_check will return at most N errors before the analysis quits, with N defaulting to 100. ] R-35592-43376:[If pragma integrity_check finds no errors, a single row with the value 'ok' is returned. ]
R-00143-55862:[The usual case is that the entire database file is checked. ] However, if the argument is TABLENAME, then checking is only performed for the the table named and its associated indexes. This is called a "partial integrity check". Because only a subset of the database is checked, errors such as unused sections of the file or duplication use of the same section of the file by two or more tables cannot be detected. The freelist is only verified on a partial integrity check if TABLENAME is sqlite_schema or one of its aliases. Support for partial integrity checks was added with version 3.33.0 (2020-08-14).
PRAGMA integrity_check does not find FOREIGN KEY errors. Use the PRAGMA foreign_key_check command to find errors in FOREIGN KEY constraints.
See also the PRAGMA quick_check command which does most of the checking of PRAGMA integrity_check but runs much faster.
R-39763-46240:[PRAGMA schema.journal_mode;
PRAGMA schema.journal_mode
= DELETE | TRUNCATE | PERSIST | MEMORY | WAL | OFF
This pragma queries or sets the journal mode for databases associated with the current database connection.
]R-34456-00884:[The first form of this pragma queries the current journaling mode for database. ] R-45251-44035:[When database is omitted, the "main" database is queried. ]
R-45883-43943:[The second form changes the journaling mode for "database" or for all attached databases if "database" is omitted. ] R-62787-27093:[The new journal mode is returned. ] R-10827-60271:[If the journal mode could not be changed, the original journal mode is returned. ]
R-19245-12964:[The DELETE journaling mode is the normal behavior. ] R-05617-50091:[In the DELETE mode, the rollback journal is deleted at the conclusion of each transaction. ] Indeed, the delete operation is the action that causes the transaction to commit. (See the document titled Atomic Commit In SQLite for additional detail.)
R-08198-48522:[The TRUNCATE journaling mode commits transactions by truncating the rollback journal to zero-length instead of deleting it. ] On many systems, truncating a file is much faster than deleting the file since the containing directory does not need to be changed.
R-44624-50921:[The PERSIST journaling mode prevents the rollback journal from being deleted at the end of each transaction. Instead, the header of the journal is overwritten with zeros. ] This will prevent other database connections from rolling the journal back. The PERSIST journaling mode is useful as an optimization on platforms where deleting or truncating a file is much more expensive than overwriting the first block of a file with zeros. See also: PRAGMA journal_size_limit and SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT.
R-43520-58856:[The MEMORY journaling mode stores the rollback journal in volatile RAM. ] R-03364-08004:[This saves disk I/O but at the expense of database safety and integrity. ] R-05226-30063:[If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the database file will very likely go corrupt. ]
R-41417-64456:[The WAL journaling mode uses a write-ahead log instead of a rollback journal to implement transactions. ] R-64967-62742:[The WAL journaling mode is persistent; after being set it stays in effect across multiple database connections and after closing and reopening the database. ] A database in WAL journaling mode can only be accessed by SQLite version 3.7.0 (2010-07-21) or later.
R-18981-44563:[The OFF journaling mode disables the rollback journal completely. ] R-20262-06249:[No rollback journal is ever created and hence there is never a rollback journal to delete. ] The OFF journaling mode disables the atomic commit and rollback capabilities of SQLite. The ROLLBACK command no longer works; it behaves in an undefined way. Applications must avoid using the ROLLBACK command when the journal mode is OFF. R-41969-26805:[If the application crashes in the middle of a transaction when the OFF journaling mode is set, then the database file will very likely go corrupt. ] Without a journal, there is no way for a statement to unwind partially completed operations following a constraint error. This might also leave the database in a corrupted state. For example, if a duplicate entry causes a CREATE UNIQUE INDEX statement to fail half-way through, it will leave behind a partially created, and hence corrupt, index. Because OFF journaling mode allows the database file to be corrupted using ordinary SQL, it is disabled when SQLITE_DBCONFIG_DEFENSIVE is enabled.
R-26383-00685:[Note that the journal_mode for an in-memory database is either MEMORY or OFF and can not be changed to a different value. ] R-04857-57605:[An attempt to change the journal_mode of an in-memory database to any setting other than MEMORY or OFF is ignored. ] R-44336-03155:[Note also that the journal_mode cannot be changed while a transaction is active. ]
PRAGMA schema.journal_size_limit
PRAGMA schema.journal_size_limit = N ;
R-23038-23996:[If a database connection is operating in exclusive locking mode or in persistent journal mode (PRAGMA journal_mode=persist) then after committing a transaction the rollback journal file may remain in the file-system. ] This increases performance for subsequent transactions since overwriting an existing file is faster than append to a file, but it also consumes file-system space. After a large transaction (e.g. a VACUUM), the rollback journal file may consume a very large amount of space.
Similarly, in WAL mode, the write-ahead log file is not truncated following a checkpoint. Instead, SQLite reuses the existing file for subsequent WAL entries since overwriting is faster than appending.
R-05912-10167:[The journal_size_limit pragma may be used to limit the size of rollback-journal and WAL files left in the file-system after transactions or checkpoints. ] R-58293-02725:[Each time a transaction is committed or a WAL file resets, SQLite compares the size of the rollback journal file or WAL file left in the file-system to the size limit set by this pragma and if the journal or WAL file is larger it is truncated to the limit. ]
R-20915-35810:[The second form of the pragma listed above is used to set a new limit in bytes for the specified database. ] R-17615-49737:[A negative number implies no limit. ] R-42584-44456:[To always truncate rollback journals and WAL files to their minimum size, set the journal_size_limit to zero. ] R-10777-25114:[Both the first and second forms of the pragma listed above return a single result row containing a single integer column - the value of the journal size limit in bytes. ] R-35812-46755:[The default journal size limit is -1 (no limit). ] The SQLITE_DEFAULT_JOURNAL_SIZE_LIMIT preprocessor macro can be used to change the default journal size limit at compile-time.
R-48576-42125:[This pragma only operates on the single database specified prior to the pragma name (or on the "main" database if no database is specified. ] ) There is no way to change the journal size limit on all attached databases using a single PRAGMA statement. The size limit must be set separately for each attached database.
R-31816-13824:[PRAGMA legacy_alter_table;
PRAGMA legacy_alter_table = boolean
This pragma sets or queries the value of the legacy_alter_table flag. ] R-49851-43011:[When this flag is on, the ALTER TABLE RENAME command (for changing the name of a table) works as it did in SQLite 3.24.0 (2018-06-04) and earlier. ] More specifically, when this flag is on the ALTER TABLE RENAME command only rewrites the initial occurrence of the table name in its CREATE TABLE statement and in any associated CREATE INDEX and CREATE TRIGGER statements. Other references to the table are unmodified, including:
This pragma is provided as a work-around for older programs that contain code that expect the incomplete behavior of ALTER TABLE RENAME found in older versions of SQLite. New applications should leave this flag turned off.
For compatibility with older virtual table implementations, this flag is turned on temporarily while the sqlite3_module.xRename method is being run. The value of this flag is restored after the sqlite3_module.xRename method finishes.
The legacy alter table behavior can also be toggled on and off using the SQLITE_DBCONFIG_LEGACY_ALTER_TABLE option to the sqlite3_db_config() interface.
The legacy alter table behavior is a per-connection setting. Turning this features on or off affects all attached database files within the database connection. The setting does not persist. Changing this setting in one connection does not affect any other connections.
R-33724-43128:[PRAGMA legacy_file_format;
This pragma no longer functions. It has become a no-op.
R-53361-24419:[PRAGMA schema.locking_mode;
PRAGMA schema.locking_mode
= NORMAL | EXCLUSIVE
]
R-39608-49000:[This pragma sets or queries the database connection locking-mode. ] R-12374-37755:[The locking-mode is either NORMAL or EXCLUSIVE. ]
R-43797-56749:[In NORMAL locking-mode (the default unless overridden at compile-time using SQLITE_DEFAULT_LOCKING_MODE), a database connection unlocks the database file at the conclusion of each read or write transaction. ] R-29276-00741:[When the locking-mode is set to EXCLUSIVE, the database connection never releases file-locks. ] R-07178-42569:[The first time the database is read in EXCLUSIVE mode, a shared lock is obtained and held. ] R-39464-36566:[The first time the database is written, an exclusive lock is obtained and held. ]
R-50610-58991:[Database locks obtained by a connection in EXCLUSIVE mode may be released either by closing the database connection, or by setting the locking-mode back to NORMAL using this pragma and then accessing the database file (for read or write). ] R-00099-40772:[Simply setting the locking-mode to NORMAL is not enough - locks are not released until the next time the database file is accessed. ]
There are three reasons to set the locking-mode to EXCLUSIVE.
R-36370-26473:[When the locking_mode pragma specifies a particular database, for example:
PRAGMA main.locking_mode=EXCLUSIVE;
then the locking mode applies only to the named database. ] R-46677-03283:[If no database name qualifier precedes the "locking_mode" keyword then the locking mode is applied to all databases, including any new databases added by subsequent ATTACH commands. ]
R-05196-58733:[The "temp" database (in which TEMP tables and indices are stored) and in-memory databases always uses exclusive locking mode. ] R-30526-43432:[The locking mode of temp and in-memory databases cannot be changed. ] R-28307-32767:[All other databases use the normal locking mode by default and are affected by this pragma. ]
R-15629-60483:[If the locking mode is EXCLUSIVE when first entering WAL journal mode, then the locking mode cannot be changed to NORMAL until after exiting WAL journal mode. ] R-52874-10360:[If the locking mode is NORMAL when first entering WAL journal mode, then the locking mode can be changed between NORMAL and EXCLUSIVE and back again at any time and without needing to exit WAL journal mode. ]
R-48957-47016:[PRAGMA schema.max_page_count;
PRAGMA schema.max_page_count = N;
Query or set the maximum number of pages in the database file. ] R-31839-40105:[Both forms of the pragma return the maximum page count. ] R-39051-42271:[The second form attempts to modify the maximum page count. ] R-23025-34321:[The maximum page count cannot be reduced below the current database size. ]
R-57347-36071:[
PRAGMA schema.mmap_size;
PRAGMA schema.mmap_size=N
Query or change the maximum number of bytes that are set aside for memory-mapped I/O on a single database. ] R-08181-17347:[The first form (without an argument) queries the current limit. ] R-01255-31602:[The second form (with a numeric argument) sets the limit for the specified database, or for all databases if the optional database name is omitted. ] R-08698-00464:[In the second form, if the database name is omitted, the limit that is set becomes the default limit for all databases that are added to the database connection by subsequent ATTACH statements. ]
R-53782-41596:[The argument N is the maximum number of bytes of the database file that will be accessed using memory-mapped I/O. ] R-14451-19951:[If N is zero then memory mapped I/O is disabled. ] R-27289-46867:[If N is negative, then the limit reverts to the default value determined by the most recent sqlite3_config(SQLITE_CONFIG_MMAP_SIZE), or to the compile time default determined by SQLITE_DEFAULT_MMAP_SIZE if not start-time limit has been set. ]
The PRAGMA mmap_size statement will never increase the amount of address space used for memory-mapped I/O above the hard limit set by the SQLITE_MAX_MMAP_SIZE compile-time option, nor the hard limit set at startup-time by the second argument to sqlite3_config(SQLITE_CONFIG_MMAP_SIZE)
The size of the memory-mapped I/O region cannot be changed while the memory-mapped I/O region is in active use, to avoid unmapping memory out from under running SQL statements. For this reason, the mmap_size pragma may be a no-op if the prior mmap_size is non-zero and there are other SQL statements running concurrently on the same database connection.
R-09711-30533:[PRAGMA module_list;
This pragma returns a list of
virtual table modules registered with the database connection.
R-49713-24018:[PRAGMA optimize;
PRAGMA optimize(MASK);
PRAGMA schema.optimize;
PRAGMA schema.optimize(MASK);
Attempt to optimize the database. ] R-27380-17544:[All schemas are optimized in the first two forms, and only the specified schema is optimized in the latter two. ]
To achieve the best long-term query performance without the need to do a detailed engineering analysis of the application schema and SQL, it is recommended that applications run "PRAGMA optimize" (with no arguments) just before closing each database connection. Long-running applications might also benefit from setting a timer to run "PRAGMA optimize" every few hours.
This pragma is usually a no-op or nearly so and is very fast. However if SQLite feels that performing database optimizations (such as running ANALYZE or creating new indexes) will improve the performance of future queries, then some database I/O may be done. Applications that want to limit the amount of work performed can set a timer that will invoke sqlite3_interrupt() if the pragma goes on for too long. Or, since SQLite 3.32.0, the application can use PRAGMA analysis_limit=N for some small value of N (a few hundred or a few thousand) to limit the depth of analyze.
The details of optimizations performed by this pragma are expected to change and improve over time. Applications should anticipate that this pragma will perform new optimizations in future releases.
The optional MASK argument is a bitmask of optimizations to perform:
Debugging mode. Do not actually perform any optimizations but instead return one line of text for each optimization that would have been done. Off by default.
Run ANALYZE on tables that might benefit. On by default. See below for additional information.
(Not yet implemented) Record usage and performance information from the current session in the database file so that it will be available to "optimize" pragmas run by future database connections.
(Not yet implemented) Create indexes that might have been helpful to recent queries.
The default MASK is and always shall be 0xfffe. The 0xfffe mask means perform all of the optimizations listed above except Debug Mode. If new optimizations are added in the future that should be off by default, those new optimizations will be given a mask of 0x10000 or larger.
To see all optimizations that would have been done without actually doing them, run "PRAGMA optimize(-1)". To use only the ANALYZE optimization, run "PRAGMA optimize(0x02)".
Determination Of When To Run Analyze
In the current implementation, a table is analyzed if and only if all of the following are true:
MASK bit 0x02 is set.
The query planner used sqlite_stat1-style statistics for one or more indexes of the table at some point during the lifetime of the current connection.
One or more indexes of the table are currently unanalyzed or the number of rows in the table has increased by 25 times or more since the last time ANALYZE was run.
The rules for when tables are analyzed are likely to change in future releases.
R-15672-33611:[PRAGMA schema.page_count;
Return the total number of pages in the database file.
]
R-36190-27688:[PRAGMA schema.page_size;
PRAGMA schema.page_size = bytes;
Query or set the page size of the database. ] R-58424-53543:[The page size must be a power of two between 512 and 65536 inclusive. ]
R-01365-26226:[When a new database is created, SQLite assigns a page size to the database based on platform and filesystem. ] For many years, the default page size was almost always 1024 bytes, but beginning with SQLite version 3.12.0 (2016-03-29), the default page size increased to 4096. The default page size is recommended for most applications.
R-58393-10545:[Specifying a new page size does not change the page size immediately. Instead, the new page size is remembered and is used to set the page size when the database is first created, if it does not already exist when the page_size pragma is issued, or at the next VACUUM command that is run on the same database connection while not in WAL mode. ]
R-64208-53052:[The SQLITE_DEFAULT_PAGE_SIZE compile-time option can be used to change the default page size assigned to new databases. ]
PRAGMA parser_trace = boolean;
If SQLite has been compiled with the SQLITE_DEBUG compile-time option, then the parser_trace pragma can be used to turn on tracing for the SQL parser used internally by SQLite. This feature is used for debugging SQLite itself.
This pragma is intended for use when debugging SQLite itself. It is only available when the SQLITE_DEBUG compile-time option is used.
R-13381-51663:[PRAGMA pragma_list;
This pragma returns a list of PRAGMA commands
known to the database connection.
PRAGMA query_only;
PRAGMA query_only = boolean;
The query_only pragma prevents data changes on database files when enabled. When this pragma is enabled, any attempt to CREATE, DELETE, DROP, INSERT, or UPDATE will result in an SQLITE_READONLY error. However, the database is not truly read-only. You can still run a checkpoint or a COMMIT and the return value of the sqlite3_db_readonly() routine is not affected.
PRAGMA schema.quick_check;
PRAGMA schema.quick_check(N)
PRAGMA schema.quick_check(TABLENAME)
R-63124-28591:[The pragma is like integrity_check except that it does not verify UNIQUE constraints and does not verify that index content matches table content. ] By skipping UNIQUE and index consistency checks, quick_check is able to run faster. PRAGMA quick_check runs in O(N) time whereas PRAGMA integrity_check requires O(NlogN) time where N is the total number of rows in the database. R-52129-08912:[Otherwise the two pragmas are the same. ]
R-15997-27576:[PRAGMA read_uncommitted;
PRAGMA read_uncommitted = boolean;
Query, set, or clear READ UNCOMMITTED isolation. ] R-13547-45635:[The default isolation level for SQLite is SERIALIZABLE. ] R-43230-40115:[Any process or thread can select READ UNCOMMITTED isolation, but SERIALIZABLE will still be used except between connections that share a common page and schema cache. ] Cache sharing is enabled using the sqlite3_enable_shared_cache() API. Cache sharing is disabled by default.
See SQLite Shared-Cache Mode for additional information.
R-14195-12074:[PRAGMA recursive_triggers;
PRAGMA recursive_triggers = boolean;
Query, set, or clear the recursive trigger capability. ]
R-55422-28457:[Changing the recursive_triggers setting affects the execution of all statements prepared using the database connection, including those prepared before the setting was changed. ] R-44241-31306:[Any existing statements prepared using the legacy sqlite3_prepare() interface may fail with an SQLITE_SCHEMA error after the recursive_triggers setting is changed. ]
Prior to SQLite version 3.6.18 (2009-09-11), recursive triggers were not supported. The behavior of SQLite was always as if this pragma was set to OFF. Support for recursive triggers was added in version 3.6.18 but was initially turned OFF by default, for compatibility. Recursive triggers may be turned on by default in future versions of SQLite.
R-10284-11658:[The depth of recursion for triggers has a hard upper limit set by the SQLITE_MAX_TRIGGER_DEPTH compile-time option and a run-time limit set by sqlite3_limit(db,SQLITE_LIMIT_TRIGGER_DEPTH,...). ]
R-10260-62465:[PRAGMA reverse_unordered_selects;
PRAGMA reverse_unordered_selects = boolean;
]
R-01669-33464:[When enabled, this PRAGMA causes many SELECT statements without an ORDER BY clause to emit their results in the reverse order from what they normally would. ] This can help debug applications that are making invalid assumptions about the result order. R-56910-04118:[The reverse_unordered_selects pragma works for most SELECT statements, however the query planner may sometimes choose an algorithm that is not easily reversed, in which case the output will appear in the same order regardless of the reverse_unordered_selects setting. ]
SQLite makes no guarantees about the order of results if a SELECT omits the ORDER BY clause. Even so, the order of results does not change from one run to the next, and so many applications mistakenly come to depend on the arbitrary output order whatever that order happens to be. However, sometimes new versions of SQLite will contain optimizer enhancements that will cause the output order of queries without ORDER BY clauses to shift. When that happens, applications that depend on a certain output order might malfunction. By running the application multiple times with this pragma both disabled and enabled, cases where the application makes faulty assumptions about output order can be identified and fixed early, reducing problems that might be caused by linking against a different version of SQLite.
PRAGMA schema.schema_version;
PRAGMA schema.schema_version = integer ;
R-04985-23577:[The schema_version pragma will get or set the value of the schema-version integer at offset 40 in the database header. ]
R-34230-56049:[SQLite automatically increments the schema-version whenever the schema changes. ] R-03189-51135:[As each SQL statement runs, the schema version is checked to ensure that the schema has not changed since the SQL statement was prepared. ] R-61095-64052:[Subverting this mechanism by using "PRAGMA schema_version=N" to change the value of the schema_version may cause SQL statement to run using an obsolete schema, which can lead to incorrect answers and/or database corruption. ] It is always safe to read the schema_version, but changing the schema_version can cause problems. R-37394-17492:[For this reason, attempts to change the value of schema_version are a silent no-op when defensive mode is enabled for a database connection. ]
Warning: Misuse of this pragma can result in database corruption.
R-32342-15392:[For the purposes of this pragma, the VACUUM command is considered a schema change, since VACUUM will usually alter the "rootpage" values for entries in the sqlite_schema table. ]
See also the application_id pragma and user_version pragma.
R-41129-04825:[PRAGMA schema.secure_delete;
PRAGMA schema.secure_delete = boolean|FAST
Query or change the secure-delete setting. ] R-26512-02966:[When secure_delete is on, SQLite overwrites deleted content with zeros. ] R-65080-38137:[The default setting for secure_delete is determined by the SQLITE_SECURE_DELETE compile-time option and is normally off. ] The off setting for secure_delete improves performance by reducing the number of CPU cycles and the amount of disk I/O. Applications that wish to avoid leaving forensic traces after content is deleted or updated should enable the secure_delete pragma prior to performing the delete or update, or else run VACUUM after the delete or update.
The "fast" setting for secure_delete (added circa 2017-08-01) is an intermediate setting in between "on" and "off". When secure_delete is set to "fast", SQLite will overwrite deleted content with zeros only if doing so does not increase the amount of I/O. In other words, the "fast" setting uses more CPU cycles but does not use more I/O. This has the effect of purging all old content from b-tree pages, but leaving forensic traces on freelist pages.
R-43448-12354:[When there are attached databases and no database is specified in the pragma, all databases have their secure-delete setting altered. ] R-36620-34941:[The secure-delete setting for newly attached databases is the setting of the main database at the time the ATTACH command is evaluated. ]
R-15326-32258:[When multiple database connections share the same cache, changing the secure-delete flag on one database connection changes it for them all. ]
Limitation: The secure_delete pragma only causes deleted content to be scrubbed from ordinary tables. If virtual tables store content in shadow tables, then deleting content from the virtual table does not necessarily remove forensic traces from the shadow tables. In particular, the FTS3 and FTS5 virtual tables that come bundled with SQLite might leave forensic traces in their shadow tables even if the secure_delete pragma is enabled.
PRAGMA short_column_names;
PRAGMA short_column_names = boolean;
Query or change the short-column-names flag. This flag affects the way SQLite names columns of data returned by SELECT statements. See the full_column_names pragma for full details.
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
PRAGMA shrink_memory
R-23445-46109:[This pragma causes the database connection on which it is invoked to free up as much memory as it can, by calling sqlite3_db_release_memory(). ]
PRAGMA soft_heap_limit
PRAGMA soft_heap_limit=N
R-26343-45930:[This pragma invokes the sqlite3_soft_heap_limit64() interface with the argument N, if N is specified and is a non-negative integer. ] R-64451-07163:[The soft_heap_limit pragma always returns the same integer that would be returned by the sqlite3_soft_heap_limit64(-1) C-language function. ]
See also the hard_heap_limit pragma.
R-02545-26933:[PRAGMA stats; ]
This pragma returns auxiliary information about tables and indices. The returned information is used during testing to help verify that the query planner is operating correctly. The format and meaning of this pragma will likely change from one release to the next. Because of its volatility, the behavior and output format of this pragma are deliberately undocumented.
The intended use of this pragma is only for testing and validation of SQLite. This pragma is subject to change without notice and is not recommended for use by application programs.
R-51288-13280:[PRAGMA schema.synchronous;
PRAGMA schema.synchronous =
0 | OFF | 1 | NORMAL | 2 | FULL | 3 | EXTRA;
Query or change the setting of the "synchronous" flag. ] R-41050-23052:[The first (query) form will return the synchronous setting as an integer. ] The second form changes the synchronous setting. The meanings of the various synchronous settings are as follows:
R-50747-49923:[In WAL mode when synchronous is NORMAL (1), the WAL file is synchronized before each checkpoint and the database file is synchronized after each completed checkpoint and the WAL file header is synchronized when a WAL file begins to be reused after a checkpoint, but no sync operations occur during most transactions. ] R-11549-19921:[With synchronous=FULL in WAL mode, an additional sync operation of the WAL file happens after each transaction commit. ] The extra WAL sync following each transaction helps ensure that transactions are durable across a power loss. Transactions are consistent with or without the extra syncs provided by synchronous=FULL. If durability is not a concern, then synchronous=NORMAL is normally all one needs in WAL mode.
The TEMP schema always has synchronous=OFF since the content of of TEMP is ephemeral and is not expected to survive a power outage. Attempts to change the synchronous setting for TEMP are silently ignored.
See also the fullfsync and checkpoint_fullfsync pragmas.
R-58425-30487:[PRAGMA schema.table_info(table-name);
This pragma returns one row for each normal column in the named table. ] R-18626-02544:[Columns in the result set include: "name" (its name); "type" (data type if given, else ''); "notnull" (whether or not the column can be NULL); "dflt_value" (the default value for the column); and "pk" (either zero for columns that are not part of the primary key, or the 1-based index of the column within the primary key). ]
R-47374-62206:[The "cid" column should not be taken to mean more than "rank within the current result set". ]
R-35224-32827:[The table named in the table_info pragma can also be a view. ]
This pragma does not show information about generated columns or hidden columns. Use PRAGMA table_xinfo to get a more complete list of columns that includes generated and hidden columns.
R-25104-48225:[PRAGMA table_list;
PRAGMA schema.table_list;
PRAGMA table_list(table-name);
R-64605-35184:[This pragma returns information about the tables and views in the schema, one table per row of output. ] The table_list pragma first appeared in SQLite version 3.37.0 (2021-11-27). As of its initial release the columns returned by the table_list pragma include those listed below. Future versions of SQLite will probably add additional columns of output.
R-50131-31524:[The default behavior is to show all tables in all schemas. ] R-17459-35869:[If the schema. name appears before the pragma, then only tables in that one schema are shown. ] R-37687-21505:[If a table-name argument is supplied, then only information about that one table is returned. ]
R-53903-19135:[PRAGMA schema.table_xinfo(table-name);
This pragma returns one row for each column in the named table, including generated columns and hidden columns. ^The output has the same columns as for PRAGMA table_info plus a column, "hidden", whose value signifies a normal column (0), a dynamic or stored generated column (2 or 3), or a hidden column in a virtual table (1). The rows for which this field is non-zero are those omitted for PRAGMA table_info.
^(PRAGMA temp_store;
PRAGMA temp_store =
0 | DEFAULT | 1 | FILE | 2 | MEMORY;
Query or change the setting of the "temp_store" parameter. ] R-41435-15049:[When temp_store is DEFAULT (0), the compile-time C preprocessor macro SQLITE_TEMP_STORE is used to determine where temporary tables and indices are stored. ] R-03927-05794:[When temp_store is MEMORY (2) temporary tables and indices are kept as if they were in pure in-memory databases. ] R-60292-04128:[When temp_store is FILE (1) temporary tables and indices are stored in a file. ] R-64488-01207:[The temp_store_directory pragma can be used to specify the directory containing temporary files when FILE is specified. ] R-28465-35432:[When the temp_store setting is changed, all existing temporary tables, indices, triggers, and views are immediately deleted. ]
R-26406-03647:[It is possible for the library compile-time C preprocessor symbol SQLITE_TEMP_STORE to override this pragma setting. ] R-33570-18895:[The following table summarizes the interaction of the SQLITE_TEMP_STORE preprocessor macro and the temp_store pragma:
]
SQLITE_TEMP_STORE PRAGMA
temp_storeStorage used for
TEMP tables and indices0 any file 1 0 file 1 1 file 1 2 memory 2 0 memory 2 1 file 2 2 memory 3 any memory
PRAGMA temp_store_directory;
PRAGMA temp_store_directory = 'directory-name';
Query or change the value of the sqlite3_temp_directory global variable, which many operating-system interface backends use to determine where to store temporary tables and indices.
When the temp_store_directory setting is changed, all existing temporary tables, indices, triggers, and viewers in the database connection that issued the pragma are immediately deleted. In practice, temp_store_directory should be set immediately after the first database connection for a process is opened. If the temp_store_directory is changed for one database connection while other database connections are open in the same process, then the behavior is undefined and probably undesirable.
Changing the temp_store_directory setting is not threadsafe. Never change the temp_store_directory setting if another thread within the application is running any SQLite interface at the same time. Doing so results in undefined behavior. Changing the temp_store_directory setting writes to the sqlite3_temp_directory global variable and that global variable is not protected by a mutex.
The value directory-name should be enclosed in single quotes. To revert the directory to the default, set the directory-name to an empty string, e.g., PRAGMA temp_store_directory = ''. An error is raised if directory-name is not found or is not writable.
The default directory for temporary files depends on the OS. Some OS interfaces may choose to ignore this variable and place temporary files in some other directory different from the directory specified here. In that sense, this pragma is only advisory.
This pragma is deprecated and exists for backwards compatibility only. New applications should avoid using this pragma. Older applications should discontinue use of this pragma at the earliest opportunity. This pragma may be omitted from the build when SQLite is compiled using SQLITE_OMIT_DEPRECATED.
PRAGMA threads;
PRAGMA threads = N;
Query or change the value of the sqlite3_limit(db,SQLITE_LIMIT_WORKER_THREADS,...) limit for the current database connection. This limit sets an upper bound on the number of auxiliary threads that a prepared statement is allowed to launch to assist with a query. The default limit is 0 unless it is changed using the SQLITE_DEFAULT_WORKER_THREADS compile-time option. When the limit is zero, that means no auxiliary threads will be launched.
This pragma is a thin wrapper around the sqlite3_limit(db,SQLITE_LIMIT_WORKER_THREADS,...) interface.
PRAGMA trusted_schema;
PRAGMA trusted_schema = boolean;
The trusted_schema setting is a per-connection boolean that determines whether or not SQL functions and virtual tables that have not been security audited are allowed to be run by views, triggers, or in expressions of the schema such as CHECK constraints, DEFAULT clauses, generated columns, expression indexes, and/or partial indexes. This setting can also be controlled using the sqlite3_db_config(db,SQLITE_DBCONFIG_TRUSTED_SCHEMA,...) C-language interface.
In order to maintain backwards compatibility, this setting is ON by default. There are advantages to turning it off, and most applications will be unaffected if it is turned off. For that reason, all applications are encouraged to switch this setting off on every database connection as soon as that connection is opened.
The -DSQLITE_TRUSTED_SCHEMA=0 compile-time option will cause this setting to default to OFF.
PRAGMA schema.user_version;
PRAGMA schema.user_version = integer ;
R-13589-35647:[The user_version pragma will get or set the value of the user-version integer at offset 60 in the database header. ] The user-version is an integer that is available to applications to use however they want. SQLite makes no use of the user-version itself.
See also the application_id pragma and schema_version pragma.
PRAGMA vdbe_addoptrace = boolean;
If SQLite has been compiled with the SQLITE_DEBUG compile-time option, then the vdbe_addoptrace pragma can be used to cause a complete VDBE opcodes to be displayed as they are created during code generation. This feature is used for debugging SQLite itself. See the VDBE documentation for more information.
This pragma is intended for use when debugging SQLite itself. It is only available when the SQLITE_DEBUG compile-time option is used.
PRAGMA vdbe_debug = boolean;
If SQLite has been compiled with the SQLITE_DEBUG compile-time option, then the vdbe_debug pragma is a shorthand for three other debug-only pragmas: vdbe_addoptrace, vdbe_listing, and vdbe_trace. This feature is used for debugging SQLite itself. See the VDBE documentation for more information.
This pragma is intended for use when debugging SQLite itself. It is only available when the SQLITE_DEBUG compile-time option is used.
PRAGMA vdbe_listing = boolean;
If SQLite has been compiled with the SQLITE_DEBUG compile-time option, then the vdbe_listing pragma can be used to cause a complete listing of the virtual machine opcodes to appear on standard output as each statement is evaluated. With listing is on, the entire content of a program is printed just prior to beginning execution. The statement executes normally after the listing is printed. This feature is used for debugging SQLite itself. See the VDBE documentation for more information.
This pragma is intended for use when debugging SQLite itself. It is only available when the SQLITE_DEBUG compile-time option is used.
PRAGMA vdbe_trace = boolean;
If SQLite has been compiled with the SQLITE_DEBUG compile-time option, then the vdbe_trace pragma can be used to cause virtual machine opcodes to be printed on standard output as they are evaluated. This feature is used for debugging SQLite. See the VDBE documentation for more information.
This pragma is intended for use when debugging SQLite itself. It is only available when the SQLITE_DEBUG compile-time option is used.
PRAGMA wal_autocheckpoint;
PRAGMA wal_autocheckpoint=N;
R-41970-42722:[This pragma queries or sets the write-ahead log auto-checkpoint interval. ] R-56511-46089:[When the write-ahead log is enabled (via the journal_mode pragma) a checkpoint will be run automatically whenever the write-ahead log equals or exceeds N pages in length. ] R-48730-20169:[Setting the auto-checkpoint size to zero or a negative value turns auto-checkpointing off. ]
R-19785-02834:[This pragma is a wrapper around the sqlite3_wal_autocheckpoint() C interface. ] R-30195-08968:[All automatic checkpoints are PASSIVE. ]
R-41040-47502:[Autocheckpointing is enabled by default with an interval of 1000 or SQLITE_DEFAULT_WAL_AUTOCHECKPOINT. ]
PRAGMA schema.wal_checkpoint;
PRAGMA schema.wal_checkpoint(PASSIVE);
PRAGMA schema.wal_checkpoint(FULL);
PRAGMA schema.wal_checkpoint(RESTART);
PRAGMA schema.wal_checkpoint(TRUNCATE);
R-64021-07698:[If the write-ahead log is enabled (via the journal_mode pragma), this pragma causes a checkpoint operation to run on database database, or on all attached databases if database is omitted. ] R-14350-06824:[If write-ahead log mode is disabled, this pragma is a harmless no-op. ]
R-64531-59395:[Invoking this pragma without an argument is equivalent to calling the sqlite3_wal_checkpoint() C interface. ]
R-47175-52442:[Invoking this pragma with an argument is equivalent to calling the sqlite3_wal_checkpoint_v2() C interface with a 3rd parameter corresponding to the argument: ]R-21320-14810:[The wal_checkpoint pragma returns a single row with three integer columns. ] R-40779-12285:[The first column is usually 0 but will be 1 if a RESTART or FULL or TRUNCATE checkpoint was blocked from completing, for example because another thread or process was actively using the database. ] R-39544-28997:[In other words, the first column is 0 if the equivalent call to sqlite3_wal_checkpoint_v2() would have returned SQLITE_OK or 1 if the equivalent call would have returned SQLITE_BUSY. ] R-08680-42661:[The second column is the number of modified pages that have been written to the write-ahead log file. ] R-33490-49513:[The third column is the number of pages in the write-ahead log file that have been successfully moved back into the database file at the conclusion of the checkpoint. ] R-26335-36429:[The second and third column are -1 if there is no write-ahead log, for example if this pragma is invoked on a database connection that is not in WAL mode. ]
R-47025-34765:[PRAGMA writable_schema = boolean;
PRAGMA writable_schema = RESET
When this pragma is on, and the SQLITE_DBCONFIG_DEFENSIVE flag is off, then the sqlite_schema table can be changed using ordinary UPDATE, INSERT, and DELETE statements. ] R-60817-01178:[If the argument is "RESET" then schema writing is disabled (as with "PRAGMA writable_schema=OFF") and, in addition, the schema is reloaded. ] R-40798-35269:[Warning: misuse of this pragma can easily result in a corrupt database file. ]
This page last modified on 2023-02-16 21:36:11 UTC
*** DRAFT ***