SQLite的PRAGME命令 PRAGMA foreign_keys = true

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

要查询当前的 PRAGMA 值，只需要提供该 pragma 的名字：

PRAGMA pragma_name;

要为 PRAGMA 设置一个新的值，语法如下：

PRAGMA pragma_name = value;

[database.]表示可以省去。

1.auto_vacuum

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

PRAGMA [database.]auto_vacuum; //主数据库就用main，附加的数据库就用设置的昵称

PRAGMA [database.]auto_vacuum = mode;

其中，mode 可以是以下任何一种：

Pragma 值描述

0 或 NONE 禁用 Auto-vacuum。这是默认模式，意味着数据库文件尺寸大小不会缩小，除非手动使用 VACUUM 命令。

1 或 FULL 启用 Auto-vacuum，是全自动的。在该模式下，允许数据库文件随着数据从数据库移除而缩小。

2 或 INCREMENTAL 启用 Auto-vacuum，但是必须手动激活。在该模式下，引用数据被维持，免费页面只放在免费列表中。这些页面可在任何时候使用incremental_vacuum pragma 进行覆盖。

2.automatic_index

查询，设置或者清除自动索引的功能。缺省值为true

PRAGMA automatic_index;

PRAGMA automatic_index = [true|false];

3.cache_size

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

PRAGMA [database.]cache_size;

PRAGMA [database.]cache_size = pages;

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

4.case_sensitive_like

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

PRAGMA case_sensitive_like = [true|false];

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

5.checkpoint_fullfsync

查询或设置fullfsync的标志值。如果设置了该值，则F_FULLFSYNC同步方法会在checkpoint操作时调用，默认值是off。只有Mac OS-X操作系统支持F_FULLFSYNC。另外，如果设定了fullfsync值，那么F_FULLFSYNC同步方法会在所有sync操作里使用，也checkpoint_fullfsync标志完全无关。

PRAGMA checkpoint_fullfsync

PRAGMA checkpoint_fullfsync = [true|false];

6.collation_list

返回当前数据库连接定义的所有排序顺序。

PRAGMA collation_list;

7.compile_options

返回编译SQLITE时使用的所有预编译宏，以”SQLITE_”打头的前缀会被忽略。

PRAGMA compile_options;

8.count_changes

count_changes Pragma 获取或设置数据操作语句的返回值，如 INSERT、UPDATE 和 DELETE。语法如下：

PRAGMA count_changes;

PRAGMA count_changes = [true|false];

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

9.database_list

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

PRAGMA database_list;

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

10.default_cache_size

设置缺省的cache sie, 是以页为单位。不幸的是，该命令也将被废弃。

PRAGMA default_cache_size;

PRAGMA default_cache_size = Number-of-pages;

11.empty_result_callbacks

仅作后向兼容用。如果将该标志值清除，sqlite3_exec()提供的回调函数（返回0或多行数据）将不被触发。

PRAGMA empty_result_callbacks;

PRAGMA empty_result_callbacks = [true|false];

12.encoding

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

PRAGMA encoding;

PRAGMA encoding = format;

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

13.foreign_key_list

返回外键列表

PRAGMA foreign_key_list(table-name);

14.foreign_keys

查询设置或者清除关于外键的限制, 外键限制只有在BEGIN或者SAVEPOINT不在PENDING状态时设置才有效。改变该设置会影响所有已经准备好的SQL语句的执行。从3.6.19开始，默认的FK强制限制是OFF。也就是说，不会强制外键依赖。

PRAGMA foreign_keys;

PRAGMA foreign_keys = [true|false];

15.freelist_count

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

PRAGMA [database.]freelist_count;

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

16.full_column_names

PRAGMA full_column_names;

PRAGMA full_column_names = [true|false];

如果有AS子句，列名就会用AS后的别名

如果结果只是普通的表达式，而不是源表的列名，则采用表达式的文本

如果使用了short_column_names开关为ON，则采用源表列名，并且不带表名前缀

如果两个开关都设为OFF，则采用第2个规则。

结果列是学有源表源列的组合：TABLE.COLUMN

17.fullfsync

PRAGMA fullfsync;

PRAGMA fullfsync = [true|false];

缺省值为OFF，也只有MAC OS支持F_FULLFSYNC

18.ignore_check_constraints

PRAGMA ignore_check_constraints = [true|false];

是否强制check约束，缺省值为off

19.incremental_vacuum

PRAGMA incremental_vacuum(N);

N页从freelist中移除。用于设定此参数。每次截短相同的页数。该命令必须是在auto_vacuum=incremental模式下才有效。如果freelist中的页数少于N，或者N小于1，或者N被完全忽略，那么整个freelist会被清除。

20.index_info

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

PRAGMA [database.]index_info( index_name );

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

21.index_list

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

PRAGMA [database.]index_list( table_name );

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

22.integrity_check

PRAGMA integrity_check;

PRAGMA integrity_check(integer);

执行整个库的完全性检查，会查看错序的记录、丢失的页，毁坏的索引等。

23.journal_mode

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

PRAGMA journal_mode;

PRAGMA journal_mode = mode;

PRAGMA database.journal_mode;

PRAGMA database.journal_mode = mode;

这里支持五种日志模式：

DELETE：默认模式。在该模式下，在事务结束时，日志文件将被删除。

TRUNCATE：日志文件被阶段为零字节长度。

PERSIST：日志文件被留在原地，但头部被重写，表明日志不再有效。

MEMORY：日志记录保留在内存中，而不是磁盘上。

OFF：不保留任何日志记录。

24.journal_size_limit

PRAGMA journal_size_limit

PRAGMA journal_size_limit = N ;

如果连接时，用了”exclusive mode(PRAGMA locking_mode=exclusive)或者(PRAGMA journal_mode=persist), 提交事务以后，journal文件会仍然在文件系系统当中。这可能会提高了效率，但是也损耗了空间。一个大的事务（如VACUUM)，会耗费大量的磁盘空间。该设置会限制journal文件的大小。默认值是－1。

25.legacy_file_format

PRAGMA legacy_file_format;

PRAGMA legacy_file_format = [true|false];

如果该值为ON，则会采用3.0.0文件格式，如果为off, 则会采用最新的文件格式，可能导致旧版本的sqlite无法打开该文件。

第一次新文件格式的sqlite3数据库打开时，该值为off.但是默认值会是on。

26.locking_mode

PRAGMA locking_mode;

PRAGMA locking_mode = NORMAL | EXCLUSIVE

缺省值是NORMAL. 数据库连接在每一个读或写事务终点的时候放掉文件锁。如果是EXCLUSIVE模式，连接永远不会释放文件锁。在此模式下，第一次执行读操作时，会获取并持有共享锁，第一次写，会获取并持有排它锁。

释放排它锁，仅当关闭数据库连接，或者将锁模式改回为NORMAL时，再次访问数据库文件（读或写）才会放掉。简单的设置为NORMAL是不够的，只有当下次再访问时才会释放排它锁。

有下述三个理由，去设置锁模式为EXCLUSIVE

应用程序需要阻止其它进程访问数据库文件

文件系统的系统调用数量减少了，导致些许性能下降

WAL日志模式可以在EXCLUSIVE模式下使用，而不需要用到共享内存

当指定数据库名时，只能目标数据库生效。如：

PRAGMA main.locking_mode=EXCLUSIVE; 不指定数据库名时，则对所有打开的数据库生效。temp或者memory数据库总是使用exclusive锁模式。

第一次进入WAL日志模式时，锁模式使用的是exclusive，这以后，锁模式也不能改变，直到退出WAL日志模式，如果锁模式开始时使用的是NORMAL，第一次进入WAL，这时锁模式可以改变，并且不需要退出WAL模式。

27.max_page_count

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

PRAGMA [database.]max_page_count;

PRAGMA [database.]max_page_count = max_page;

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

28.page_count

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

PRAGMA [database.]page_count;

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

29.page_size

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

PRAGMA [database.]page_size;

PRAGMA [database.]page_size = bytes;

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

30.parser_trace

parser_trace Pragma 随着它解析 SQL 命令来控制打印的调试状态，语法如下：

PRAGMA parser_trace = [true|false];

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

31.read_uncommitted

PRAGMA read_uncommitted;

PRAGMA read_uncommitted = boolean;

读未提交开关。缺省的事务隔离级是：可串行化。任何进程或线程都可以设置读未提交隔离级，但是，SERIALIZABLE仍被使用，除了共享某页和表模式的缓存的那些连接。

32.recursive_triggers

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

PRAGMA recursive_triggers;

PRAGMA recursive_triggers = [true|false];

33.reverse_unordered_selects

PRAGMA reverse_unordered_selects;

PRAGMA reverse_unordered_selects = [true|false];

当开启此开关时，不带order by的select语句，会输出相反顺序的结果。

34.schema_version

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

PRAGMA [database.]schema_version;

PRAGMA [database.]schema_version = number;

这是一个 32 位有符号整数值，用来跟踪架构的变化。每当一个架构改变命令执行（比如 CREATE… 或 DROP…）时，这个值会递增。

35.secure_delete

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

PRAGMA secure_delete;

PRAGMA secure_delete = [true|false];

PRAGMA database.secure_delete;

PRAGMA database.secure_delete = [true|false];

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

36.short_column_names

PRAGMA short_column_names;

PRAGMA short_column_names = boolean;

37.sql_trace

sql_trace Pragma 用于把 SQL 跟踪结果转储到屏幕上。语法如下：

PRAGMA sql_trace;

PRAGMA sql_trace = [true|false];

SQLite 必须通过 SQLITE_DEBUG 指令来编译要引用的该 Pragma。

38.synchronous

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

PRAGMA [database.]synchronous;

PRAGMA [database.]synchronous = mode;

SQLite 支持下列同步模式：

Pragma 值描述

0 或 OFF 不进行同步。

1 或 NORMAL 在关键的磁盘操作的每个序列后同步。

2 或 FULL 在每个关键的磁盘操作后同步。

39.table_info

返回表的基本信息

PRAGMA table_info(table-name);

40.temp_store

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

PRAGMA temp_store;

PRAGMA temp_store = mode;

SQLite 支持下列存储模式：

Pragma 值描述

0 或 DEFAULT 默认使用编译时的模式。通常是 FILE。

1 或 FILE 使用基于文件的存储。

2 或 MEMORY 使用基于内存的存储。

41.temp_store_directory

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

PRAGMA temp_store_directory;

PRAGMA temp_store_directory = 'directory_path';

42.user_version

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

PRAGMA [database.]user_version;

PRAGMA [database.]user_version = number;

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

43.wal_autocheckpoint

PRAGMA wal_autocheckpoint;

PRAGMA wal_autocheckpoint = N;

设置WAL自动检查点的间隔（以页为单位）, 缺省值是1000。

44.wal_checkpoint

PRAGMA [database].wal_checkpoint;

PRAGMA [database].wal_checkpoint(PASSIVE);

PRAGMA [database].wal_checkpoint(FULL);

PRAGMA [database].wal_checkpoint(RESTART);

45.writable_schema

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

PRAGMA writable_schema;

PRAGMA writable_schema = [true|false];

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