SQLite PRAGMA

sqlite pragma

sqlite 的 pragma 命令是一个特殊的命令,可以用在 sqlite 环境内控制各种环境变量和状态标志。一个 pragma 值可以被读取,也可以根据需求进行设置。

 

1. 语法

要查询当前的 pragma 值,只需要提供该 pragma 的名字:

pragma pragma_name;

要为 pragma 设置一个新的值,语法如下:

pragma pragma_name = value;

设置模式,可以是名称或等值的整数,但返回的值将始终是一个整数。

 

2. auto_vacuum pragma

auto_vacuum pragma 获取或设置 auto-vacuum 模式。语法如下:

pragma [database.]auto_vacuum;
pragma [database.]auto_vacuum = mode;

其中,mode 可以是以下任何一种:

pragma 值描述
0 或 none禁用 auto-vacuum。这是默认模式,意味着数据库文件尺寸大小不会缩小,除非手动使用 vacuum 命令。
1 或 full启用 auto-vacuum,是全自动的。在该模式下,允许数据库文件随着数据从数据库移除而缩小。
2 或 incremental启用 auto-vacuum,但是必须手动激活。在该模式下,引用数据被维持,自由页面只放在自由列表中。这些页面可在任何时候使用 incremental_vacuum pragma 进行覆盖。

 

3. cache_size pragma

cache_size pragma 可获取或暂时设置在内存中页面缓存的最大尺寸。语法如下:

pragma [database.]cache_size;
pragma [database.]cache_size = pages;

pages 值表示在缓存中的页面数。内置页面缓存的默认大小为 2,000 页,最小尺寸为 10 页。

 

4. case_sensitive_like pragma

case_sensitive_like pragma 控制内置的 like 表达式的大小写敏感度。默认情况下,该 pragma 为 false,这意味着,内置的 like 操作符忽略字母的大小写。语法如下:

pragma case_sensitive_like = [true|false];

目前没有办法查询该 pragma 的当前状态。

 

5. count_changes pragma

count_changes pragma 获取或设置数据操作语句的返回值,如 insert、update 和 delete。语法如下:

pragma count_changes;
pragma count_changes = [true|false];

默认情况下,该 pragma 为 false,这些语句不返回任何东西。如果设置为 true,每个所提到的语句将返回一个单行单列的表,由一个单一的整数值组成,该整数表示操作影响的行。

 

6. database_list pragma

database_list pragma 将用于列出了所有的数据库连接。语法如下:

pragma database_list;

该 pragma 将返回一个单行三列的表格,每当打开或附加数据库时,会给出数据库中的序列号,它的名称和相关的文件。

 

7. encoding pragma

encoding pragma 控制字符串如何编码及存储在数据库文件中。语法如下:

pragma encoding;
pragma encoding = format;

格式值可以是 utf-8、utf-16le 或 utf-16be 之一。

 

8. freelist_count pragma

freelist_count pragma 返回一个整数,表示当前被标记为免费和可用的数据库页数。语法如下:

pragma [database.]freelist_count;

 

9. index_info pragma

index_info pragma 返回关于数据库索引的信息。语法如下:

pragma [database.]index_info( index_name );

结果集将为每个包含在给出列序列的索引、表格内的列索引、列名称的列显示一行。

 

10. index_list pragma

index_list pragma 列出所有与表相关联的索引。语法如下:

pragma [database.]index_list( table_name );

结果集将为每个给出列序列的索引、索引名称、表示索引是否唯一的标识显示一行。

 

11. journal_mode pragma

journal_mode pragma 获取或设置控制日志文件如何存储和处理的日志模式。语法如下::

pragma journal_mode;
pragma journal_mode = mode;
pragma database.journal_mode;
pragma database.journal_mode = mode;

这里支持五种日志模式:

pragma 值描述
delete默认模式。在该模式下,在事务结束时,日志文件将被删除。
truncate日志文件被阶段为零字节长度。
persist日志文件被留在原地,但头部被重写,表明日志不再有效。
memory日志记录保留在内存中,而不是磁盘上。
off不保留任何日志记录。

 

12. max_page_count pragma

max_page_count pragma 为数据库获取或设置允许的最大页数。语法如下:

pragma [database.]max_page_count;
pragma [database.]max_page_count = max_page;

默认值是 1,073,741,823,这是一个千兆的页面,即如果默认 1 kb 的页面大小,那么数据库中增长起来的一个兆字节。

 

13. page_count pragma

page_count pragma 返回当前数据库中的网页数量。语法如下:

pragma [database.]page_count;

数据库文件的大小应该是 page_count * page_size。

 

14. page_size pragma

page_size pragma 获取或设置数据库页面的大小。语法如下:

pragma [database.]page_size;
pragma [database.]page_size = bytes;

默认情况下,允许的尺寸是 512、1024、2048、4096、8192、16384、32768 字节。改变现有数据库页面大小的唯一方法就是设置页面大小,然后立即 vacuum 该数据库。

 

15. parser_trace pragma

parser_trace pragma 随着它解析 sql 命令来控制打印的调试状态,语法如下:

pragma parser_trace = [true|false];

默认情况下,它被设置为 false,但设置为 true 时则启用,此时 sql 解析器会随着它解析 sql 命令来打印出它的状态。

 

16. recursive_triggers pragma

recursive_triggers pragma 获取或设置递归触发器功能。如果未启用递归触发器,一个触发动作将不会触发另一个触发。语法如下:

pragma recursive_triggers;
pragma recursive_triggers = [true|false];

 

17. schema_version pragma

schema_version pragma 获取或设置存储在数据库头中的的架构版本值。语法如下:

pragma [database.]schema_version;
pragma [database.]schema_version = number;

这是一个 32 位有符号整数值,用来跟踪架构的变化。每当一个架构改变命令执行(比如 create... 或 drop...)时,这个值会递增。

 

18. secure_delete pragma

secure_delete pragma 用来控制内容是如何从数据库中删除。语法如下:

pragma secure_delete;
pragma secure_delete = [true|false];
pragma database.secure_delete;
pragma database.secure_delete = [true|false];

安全删除标志的默认值通常是关闭的,但是这是可以通过 sqlite_secure_delete 构建选项来改变的。

 

19. sql_trace pragma

sql_trace pragma 用于把 sql 跟踪结果转储到屏幕上。语法如下:

pragma sql_trace;
pragma sql_trace = [true|false];

sqlite 必须通过 sqlite_debug 指令来编译要引用的该 pragma。

 

20. synchronous pragma

synchronous pragma 获取或设置当前磁盘的同步模式,该模式控制积极的 sqlite 如何将数据写入物理存储。语法如下:

pragma [database.]synchronous;
pragma [database.]synchronous = mode;

sqlite 支持下列同步模式:

pragma 值描述
0 或 off不进行同步。
1 或 normal在关键的磁盘操作的每个序列后同步。
2 或 full在每个关键的磁盘操作后同步。

 

21. temp_store pragma

temp_store pragma 获取或设置临时数据库文件所使用的存储模式。语法如下:

pragma temp_store;
pragma temp_store = mode;

sqlite 支持下列存储模式:

pragma 值描述
0 或 default默认使用编译时的模式。通常是 file。
1 或 file使用基于文件的存储。
2 或 memory使用基于内存的存储。

 

22. temp_store_directory pragma

temp_store_directory pragma 获取或设置用于临时数据库文件的位置。语法如下:

pragma temp_store_directory;
pragma temp_store_directory = 'directory_path';

 

23. user_version pragma

user_version pragma 获取或设置存储在数据库头的用户自定义的版本值。语法如下:

pragma [database.]user_version;
pragma [database.]user_version = number;

这是一个 32 位的有符号整数值,可以由开发人员设置,用于版本跟踪的目的。

 

24. writable_schema pragma

writable_schema pragma 获取或设置是否能够修改系统表。语法如下:

pragma writable_schema;
pragma writable_schema = [true|false];

如果设置了该 pragma,则表以 sqlite_ 开始,可以创建和修改,包括 sqlite_master 表。使用该 pragma 时要注意,因为它可能导致整个数据库损坏。

下一节:sqlite 约束

sqlite教程

相关文章