SQLite - PRAGMA 命令

SQLite 的PRAGMA 命令是一个特殊的命令，用于控制 SQLite 环境中的各种环境变量和状态标志。可以读取 PRAGMA 值，也可以根据需要设置 PRAGMA 值。

语法

要查询当前的 PRAGMA 值，只需提供 pragma 的名称。

PRAGMA pragma_name;

要为 PRAGMA 设置新值，请使用以下语法。

PRAGMA pragma_name = value;

设置模式可以是名称或整数等效值，但返回值始终为整数。

auto_vacuum Pragma

auto_vacuum pragma 获取或设置自动真空模式。以下是简单的语法。

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

其中mode可以是以下任何一个：

序号	Pragma 值 & 描述
1	0 或 NONE 禁用自动真空。这是默认模式，这意味着数据库文件的大小永远不会缩小，除非使用 VACUUM 命令手动进行真空操作。
2	1 或 FULL 启用自动真空并使其完全自动，允许数据库文件在从数据库中删除数据时缩小。
3	2 或 INCREMENTAL 启用自动真空，但必须手动激活。在此模式下，维护引用数据，但空闲页面仅放在空闲列表中。可以使用incremental_vacuum pragma随时恢复这些页面。

序号

Pragma 值 & 描述

0 或 NONE

禁用自动真空。这是默认模式，这意味着数据库文件的大小永远不会缩小，除非使用 VACUUM 命令手动进行真空操作。

1 或 FULL

启用自动真空并使其完全自动，允许数据库文件在从数据库中删除数据时缩小。

2 或 INCREMENTAL

启用自动真空，但必须手动激活。在此模式下，维护引用数据，但空闲页面仅放在空闲列表中。可以使用incremental_vacuum pragma随时恢复这些页面。

cache_size Pragma

cache_size pragma 可以获取或临时设置内存中页面缓存的最大大小。以下是简单的语法。

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

pages值表示缓存中的页面数。内置页面缓存的默认大小为 2000 个页面，最小大小为 10 个页面。

case_sensitive_like Pragma

case_sensitive_like pragma 控制内置 LIKE 表达式的区分大小写。默认情况下，此 pragma 为 false，这意味着内置 LIKE 运算符会忽略字母大小写。以下是简单的语法。

PRAGMA case_sensitive_like = [true|false];

无法查询此 pragma 的当前状态。

count_changes Pragma

count_changes pragma 获取或设置数据操作语句（如 INSERT、UPDATE 和 DELETE）的返回值。以下是简单的语法。

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

默认情况下，此 pragma 为 false，这些语句不返回任何内容。如果设置为 true，则每个提到的语句都将返回一个包含单个整数值的一列一行的表，该值指示操作影响的行数。

database_list Pragma

database_list pragma 用于列出所有附加的数据库。以下是简单的语法。

PRAGMA database_list;

此 pragma 将返回一个三列表，每行对应一个打开或附加的数据库，给出数据库序列号、其名称和关联的文件。

encoding Pragma

encoding pragma 控制字符串如何在数据库文件中编码和存储。以下是简单的语法。

PRAGMA encoding;
PRAGMA encoding = format;

format 值可以是UTF-8、UTF-16le或UTF-16be之一。

freelist_count Pragma

freelist_count pragma 返回一个表示当前标记为可用空闲的数据库页面数量的单个整数。以下是简单的语法。

PRAGMA [database.]freelist_count;

format 值可以是UTF-8、UTF-16le或UTF-16be之一。

index_info Pragma

index_info pragma 返回有关数据库索引的信息。以下是简单的语法。

PRAGMA [database.]index_info( index_name );

结果集将包含索引中每个列的一行，给出列序列、表中的列索引和列名。

index_list Pragma

index_list pragma 列出与表关联的所有索引。以下是简单的语法。

PRAGMA [database.]index_list( table_name );

结果集将包含每个索引的一行，给出索引序列、索引名称以及指示索引是否唯一的标志。

journal_mode Pragma

journal_mode pragma 获取或设置日志模式，该模式控制日志文件如何存储和处理。以下是简单的语法。

PRAGMA journal_mode;
PRAGMA journal_mode = mode;
PRAGMA database.journal_mode;
PRAGMA database.journal_mode = mode;

下表列出了五种支持的日志模式。

序号	Pragma 值 & 描述
1	DELETE 这是默认模式。在此模式下，在事务结束时，将删除日志文件。
2	TRUNCATE 日志文件将截断为零字节长度。
3	PERSIST 日志文件将保留在原处，但标题将被覆盖以指示日志不再有效。
4	MEMORY 日志记录保存在内存中，而不是磁盘上。
5	OFF 不保留日志记录。

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，则允许数据库增长到 1 TB。

page_count Pragma

page_count pragma 返回数据库中当前的页面数。以下是简单的语法：

PRAGMA [database.]page_count;

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

page_size Pragma

page_size pragma 获取或设置数据库页面的大小。以下是简单的语法。

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

默认情况下，允许的大小为 512、1024、2048、4096、8192、16384 和 32768 字节。更改现有数据库页面大小的唯一方法是设置页面大小，然后立即 VACUUM 数据库。

parser_trace Pragma

parser_trace pragma 控制在解析 SQL 命令时打印调试状态。以下是简单的语法。

PRAGMA parser_trace = [true|false];

默认情况下，它设置为 false，但当通过将其设置为 true 启用时，SQL 解析器将在解析 SQL 命令时打印其状态。

recursive_triggers Pragma

recursive_triggers pragma 获取或设置递归触发器功能。如果未启用递归触发器，则触发器操作将不会触发另一个触发器。以下是简单的语法。

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

schema_version Pragma

schema_version pragma 获取或设置存储在数据库头中的模式版本值。以下是简单的语法。

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

这是一个 32 位有符号整数，用于跟踪模式更改。每当执行更改模式的命令（如 CREATE... 或 DROP...）时，此值都会递增。

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 构建选项更改。

sql_trace Pragma

sql_trace pragma 用于将 SQL 跟踪结果转储到屏幕上。以下是简单的语法。

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

SQLite 必须使用 SQLITE_DEBUG 指令编译才能包含此 pragma。

synchronous Pragma

synchronous pragma 获取或设置当前磁盘同步模式，该模式控制 SQLite 将数据写入物理存储的力度。以下是简单的语法。

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

SQLite 支持以下同步模式，如表中所列。

序号	Pragma 值 & 描述
1	0 或 OFF 根本不进行同步
2	1 或 NORMAL 在每个关键磁盘操作序列后同步
3	2 或 FULL 在每个关键磁盘操作后同步

序号

Pragma 值 & 描述

0 或 OFF

根本不进行同步

1 或 NORMAL

在每个关键磁盘操作序列后同步

2 或 FULL

在每个关键磁盘操作后同步

temp_store Pragma

temp_store pragma 获取或设置临时数据库文件使用的存储模式。以下是简单的语法。

PRAGMA temp_store;
PRAGMA temp_store = mode;

SQLite 支持以下存储模式。

序号	Pragma 值 & 描述
1	0 或 DEFAULT 使用编译时默认值。通常为 FILE。
2	1 或 FILE 使用基于文件的存储。
3	2 或 MEMORY 使用基于内存的存储。

序号

Pragma 值 & 描述

0 或 DEFAULT

使用编译时默认值。通常为 FILE。

1 或 FILE

使用基于文件的存储。

2 或 MEMORY

使用基于内存的存储。

temp_store_directory Pragma

temp_store_directory pragma 获取或设置临时数据库文件使用的位置。以下是简单的语法。

PRAGMA temp_store_directory;
PRAGMA temp_store_directory = 'directory_path';

user_version Pragma

user_version pragma 获取或设置存储在数据库头中的用户定义版本值。以下是简单的语法。

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

这是一个 32 位有符号整数，开发人员可以将其设置为版本跟踪目的。

writable_schema Pragma

writable_schema pragma 获取或设置修改系统表的能力。以下是简单的语法。

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

如果设置了此 pragma，则可以创建和修改以 sqlite_ 开头的表，包括 sqlite_master 表。使用 pragma 时要小心，因为它可能导致数据库完全损坏。

打印页面