PRAGMA command 是一个特殊的命令。它用于修改 sqlite 库操作或查询库以取得内部（非表）数据。 PRAGMA 命令可以使用与其它 sqlite 命令（如 SELECT、INSERT）相同的接口，只在有如下几个重要方面有所不同：

• 在未来的sqlite版本中，某些 pragma 语句可能会被删除，也可能添加新的。所以，使用时请多加小心！
• 如果执行一个未知的 pragma ，不会给出错误提示。未知的 PRAGMA 只是简单的被忽略。这意味着如果你在使用 PRAGMA 时打错了字，那么 sqlite 库不会给你提示。
• 有一些 pragma 会在编译 sql的阶段起作用，而不是在执行阶段。这意味着使用 C 语言的 sqlite3_prepare()、sqlite3_step() 或 sqlite3_finalize() 等 API (或类似的包装好的接口） 时，pragma 可能会在执行 sqlite3_prepare()调用时就已执行。
• pragma 命令貌似与其它的 sql 引擎不兼容。

有四类可用的 pragma：

• Pragma 用于以某种方式 修改 sqlite 库的运行 (modify the operation) ，或者查询当前的运行方式。
• Pragmas 用于 查询当前数据库的模式(schema)。
• Pragmas 用于 查询或修改两个数据库版本值， schema-version 和 the user-version。
• Pragmas 用于 调试库（Library），并且验证数据库文件没有被损坏。

---

PRAGMA command Syntax sql-statement ::= PRAGMA name [ = value] @H_403_58@|
PRAGMA function @H_403_58@( arg @H_403_58@)

pragma 接受一个整数值 value 或一个名字符号。字符串 "on","true" 以及 "yes" 与 1 是等价的。字符串 "off","false",和 "no" 则等价于 0。这些字符串是不区分大小写的，也不需要双引号。不能识别的字符串将被认为是 1，而不会提示错误。当返回 value 时，它被看作是一个整数。

---

修改库运行方式的 Pragma

• PRAGMA auto_vacuum;
  PRAGMA auto_vacuum = 0 | none | 1 | full | 2 | incremental;

  在数据库中查询或设置 auto-vacuum 。

  通常（也就是说在 auto_vacuum 是 0 或 none的时候）， 当一个从数据库中删除数据的事务提交时，数据库文件大小不会改变， 未被使用的数据库文件页空间被记入一个“空闲列表”中， 这样，这些空间在以后的 INSERT 中就可以重用。所以， 数据库文件不会缩小。 在这种模式下，可以使用VACUUM 命令来回收未用的空间。

  如果 auto-vacuum 标志是 1 (full，完全模式)，空闲列表中的页将会移到文件的尾部， 那么，当每次提交事务时，就可以通过将文件截断来翻译空闲列表中的页。 但请注意， auto-vacuum 只会从数据库文件中载断空闲列表中的页， 而不会回收数据库中的碎片，也不会像VACUUM 命令那样重新整理数据库内容。实际上，由于需要在数据库文件中移动页， auto-vacuum 会产生更多的碎片。

  要使用 auto-vacuum，需要一些前题条件。 数据库中需要存储一些额外的信息以记录它所跟踪的每个数据库页都找回其指针位置。 所以，auto-vacumm 必须在建表之前就开启。在一个表创建之后， 就不能再开启或关闭 auto-vacumm。

  如果 auto-vacuum 的值是 2 (incremental，增量模式) ，那么，自动 vacuum 需要使用存放在数据库文件中的另外的信息。但它不会像 auto_vacuum == full 那样在每次事务提交的时候发生。在增量模式下，必须使用独立的 incremental_vacuum pragma 来引发 vacuum。

  数据库连接可以自由地在完全和增量模式间切换。但是， 如果数据库中已经建了一个表，连接就不能切换到 none 模式， 也不能从 none 模式切换成别的模式。

• PRAGMA cache_size;
  PRAGMA cache_size = Number-of-pages;

  查询可修改 sqlite 一次可以在内存中保持的数据库磁盘页数量的最大值。 每一页大约需要 1.5K 的内存空间。缺省值是2000。 如果你需要做大的 UPDATE 或 DELETE 操作，每次会影响相当多的数据库行， 并且你也不在乎 sqlite 占用更多的内存，那么，你就可以增加缓存的大小， 这样，以获得可能的速度的提升。

  当你使用 cache_size pragma 修改缓存大小以后， 改变只会对当前的会话起作用。数据库连接关闭并重新连接后， 它又会变成缺省的大小。如果要永久修改缓存值，则需要使用 default_cache_size

• PRAGMA case_sensitive_like;
  PRAGMA case_sensitive_like = 0 | 1;

  对于 latin1 字符，LIKE 操作符缺省的行为会忽略大小写。 也就是说，默认情况下， 'a' LIKE 'A' 的结果是true。 可以通过开启该 pragma 来改变这种行为。当启用 case_sensitive_like 后，'a' LIKE 'A' 会是 false 但 'a' LIKE 'a' 仍然是 true.

• PRAGMA count_changes;
  PRAGMA count_changes = 0 | 1;

  查询或修改 count-changes 标志。通常， 没有设置 count-changes ，则 INSERT,UPDATE 和 DELETE 语句不会返回任何数据。 当设置该值时，这些命令都会返回由一个整数组成的一行数据， 该整数表示被该命令所插入，修改或删除的行数， 但不包括任何由触发器插入、修改或删除的行。

• PRAGMA default_cache_size;
  PRAGMA default_cache_size = Number-of-pages;

  查询或设置 sqlite 可在内存中同时保持的数据库磁盘文件页， 每占用 1K 磁盘空间的页需要大约 1.5K 的内存。 该 pragma 类似cache_size 。 只是，它会永久改变缓存的值。通过该 pragma， 可以一次设置缓存值，以后每次后新打开数据库时都将使用该值。

• PRAGMA default_synchronous;

  该 pragma 在 2.8 版本中可用，但在 3.0 中删除了。 使用它非常危险，因此也不推荐使用。 为帮助2.8版本的用户不再使用该 pragma， 本文档不会告诉你它怎么用。

• PRAGMA empty_result_callbacks;
  PRAGMA empty_result_callbacks = 0 | 1;

  查询或设置 empty-result-callbacks 标志。

  该标志只会影响 sqlite3_exec API。 通常，当清除该标志时，如果命令返回 0 行数据， 则不会引发用于 sqlite3_exec()上的回调函数。 但若在这种情况下设置了 empty_result_callbacks， 则回调函数会将第三个参数置为 0 （NULL） 并进行调用，且只会调用一次。 这可以使用调用 sqlite3_exec() API 的程序即使在没有返回数据的情况下也可以获得列名。

• PRAGMA encoding;
  PRAGMA encoding = "UTF-8";
  PRAGMA encoding = "UTF-16";
  PRAGMA encoding = "UTF-16le";
  PRAGMA encoding = "UTF-16be";

  第一种格式，主数据库已创建。那么该 pragma 会返回主数据库所使用的文件编码。 可能是： "UTF-8","UTF-16le" (小印第安 UTF-16 编码) 或 "UTF-16be" (大印第安 UTF-16 编码)。 如果主数据库没有创建， 那么返回值将是将要用于创建主数据库的文本编码（如果在当前会话中创建的话）。

  第二种以及以后的格式只有在主数据库未创建时有用。 在这种情况下，该 pragma 将会把数据库编码设为在当前会话中将要创建的数据库所使用的编码。 字符串“UTF-16”会被解释为“本机字节顺序的UTF-16编码”。 若第二种及以后的格式用于已创建的数据库文件上， 则它们会被默默地忽略而不起任何作用。

  一旦为数据库设置了字符编码，就不能再更改。

  使用 ATTACH 命令创建的数据库记录使用与主数据相同的编码。

• PRAGMA full_column_names;
  PRAGMA full_column_names = 0 | 1;

  查询或修改 full-column-names 标志。 该标志会影响当 SELECT 查询后面的列表是一个 “表-列名” 或 “*”时 sqlite返回列名的方式。通常， 如果 SELECT 语句连接两个或多个表， 结果列名将是 <表名/别名><列名>； 而若仅仅对单个表查询时，将是 <column-name>。 但如果设置了 full-column-names 标志，列名将永远是 <table-name/alias> <column-name> ， 而不管是只查询一个表或同时连接多个表。

  如果 short-column-names 和 full-column-names 都设置了， 则会以 full-column-names 为准。

• PRAGMA fullfsync
  PRAGMA fullfsync = 0 | 1;

  查询修改 fullfsync 标志。 该标志影响在支持 F_FULLFSYNC 同步方法的系统上，是否使用该方法。 默认值是 off (不使用)。 在写本文的时候 (2006-02-10)，只有 Mac OS X 支持 F_FULLFSYNC。

• PRAGMA incremental_vacuum(N);

  Incremental_vacuum pragma 会导致从空闲列表中最多移除 N 页。 数据库文件也会按该数量截断。如果数据库不在 auto_vacuum==incremental 模式， 或空闲列表中没有页，则该 pragma 不起作用。 如果空闲列表中不到N页，那么，整个空闲列表会被清空。

  对于 3.4.0版来说 (第一个支持 incremental_vacuum 的版本) ， 该我仍然是试验性的。未来可能会增强该功能，包括像 VACUUM 命令那样整理碎片以及节点重整等。 并且，增量 vacuum 可能会从 pragma 变为一个单独的 sql 命令， 也许会是 VACUUM 命令的变体。程序员们要注意不要迷恋于当前的语法， 因为以后有可能会改变。

• PRAGMA legacy_file_format;
  PRAGMA legacy_file_format = ON | OFF

  本 pragma 设置或查询 legacy_file_format 标志的值。 当它为 on 时，新创建的数据库文件格式可以被3.0.0以后的版本读写。 如果它为 off，则会使用最新的数据库文件格式，旧版本的sqlite将无法读写。

  当不带参数使用该 pragma 时，它返回该标志当前的值。 它 不会 告诉你当前数据库所使用的文件格式， 而只会表明在以后创建新数据库时将使用何种格式。

  该标志只对新创建数据库有效。对已存在的数据库不起作用。

• PRAGMA locking_mode;
  PRAGMA locking_mode = NORMAL | EXCLUSIVE

  该 pragma 设置或查询数据库连接的锁模式。 锁模式可能是 NORMAL 或 EXCLUSIVE.

  在 NORMAL 模式下， (默认值),一个数据库连接会在每次完成读或写时释放数据库文件锁。 当锁模式设为 EXCLUSIVE 时，数据库连接永远不会释放文件锁。 在该模式下，当第一次读数据库文件时，会获得并持有一个共享锁。 当第一次向数据库写时，将获得并持有一个排它锁。

  在 EXCLUSIVE 模式下获得的锁可以通过关闭数据库连接来释放， 也可以通过使用该 pragma 将锁模式改为 NORMAL，并且再次访问（读或写） 数据库来释放。仅仅将锁模式置为 NORMAL 是不够的， 直到下一次访问数据库文件时才会释放已持有的锁。

  有两种原因要求设置 EXCLUSIVE 锁模式。 一是一个应用程序确实不希望其它进程访问数据库文件。 二是在这种模式下可以使用优化器，它可以节省少量的磁盘文件操作。 这在嵌入式系统中可能非常重要。

  当 locking_mode pragma 指定一个特定的数据库时，如：

  PRAGMA main.locking_mode=EXCLUSIVE;

  那么，锁模式只会对该数据库有效。如果不指定数据库名称， 那么锁模式会应用于所有数据库，包括以后使用 ATTACH命令连接的数据库。

  临时（ temp） 数据库 (用于存放临时表和索引)永远使用 EXCLUSIVE 锁模式。临时数据库的锁模式不能改变。所有其它的数据库则默认使用 NORMAL 锁模式，并可以通过使用 pragma 改变。

• PRAGMA page_size;
  PRAGMA page_size = bytes;

  查询或设置数据库的 page-size 。只能在数据库创建之间设置 page-size。 页的大小必须是 2 的幂， 且幂指数只能在 512 和 8192 之间。 其上限可以在编译时通过修改源代码中的 sqlITE_MAX_PAGE_SIZE 修改， 但最大不能超过32768。

• PRAGMA max_page_count;
  PRAGMA max_page_count = N;

  查询或设置数据库文件最大的页数。 两种格式都会返回最大的页数。第二种格式试图修改最大页数。 最大页数不能修改为小于当前数据库的大小。

• PRAGMA read_uncommitted;
  PRAGMA read_uncommitted = 0 | 1;

  查询，设置或清除 READ UNCOMMITTED （读未提义）隔离级别。 sqlite 默认的隔离级别是 SERIALIZABLE (可串行化）。 任何进程或线程都可以选择 READ UNCOMMITTED 级别。但除了在数据库连接间共享一个通过页和模式缓存外，仍然会使用 SERIALIZABLE 隔离级别。 共享缓存可以使用 sqlite3_enable_shared_cache() API 开启， 并且只能在执行同一线程的连接间开启。共享缓存默认是关闭的。

• PRAGMA short_column_names;
  PRAGMA short_column_names = 0 | 1;

  查询或修改 short-column-names 标志。 该标志会影响当 SELECT 查询后面的列表是一个 “表-列名” 或 “*”时 sqlite返回列名的方式。 通常， 如果 SELECT 语句连接两个或多个表， 结果列名将是 <表名/别名><列名>； 而若仅仅对单个表查询时，将是 <column-name>。 但如果设置了 short-column-names 标志，列名将永远是 <column-name> ， 而不管是只查询一个表或同时连接多个表。

  如果 short-column-names 和 full-column-names 都设置了， 则以 full-column-names 标志为准。

• PRAGMA synchronous;
  PRAGMA synchronous = FULL; (2)
  PRAGMA synchronous = NORMAL; (1)
  PRAGMA synchronous = OFF; (0)

  查询或设置 synchronous 标志。 第一种格式返回一个整数，当 synchronous 为 FULL (2) 时， sqlite 数据库引擎将会在重要的时刻暂停， 以保证在继续运行之前数据确实已经写到磁盘上去了。 这能保证在遇到操作系统崩溃可电源故障时， 重新启动机器数据库文件不会被破坏。FULL 同步方式是非常安全的， 但也是很慢的。若 synchronous 设为 NORMAL，则 sqlite 数据库引擎将在大多数重要时刻暂停，但比在 FULL 模式要少。 在极少情况下，处理这种模式的数据库文件可能会由于“不是时候” 的电源故障而导致受损。但在实际应用中， 更有可有遭受到灾难性的磁盘故障或其它无法恢复的硬件故障。 若将 synchronous 设为 OFF (0)，那么 sqlite 从操作系统取得数据后将会立即进行处理而不会暂停。 如果使用 sqlite 的应用程序崩溃，数据将是安全的。 但如果在数据写入磁盘之前，操作系统死机或机器断电， 数据库文件可能会损坏。此外，在该模式下， 某些操作会比其它情况下快 50 倍。

  在 sqlite 版本 2 中，默认值是 NORMAL。 对于版本 3， 默认值是 FULL。

• PRAGMA temp_store;
  PRAGMA temp_store = DEFAULT; (0)
  PRAGMA temp_store = FILE; (1)
  PRAGMA temp_store = MEMORY; (2)

  查询或改变 temp_store 参数的设置。 当 temp_sore 为 DEFAULT (0) 时，将根据编译时的 C 语言预处理宏决定如何存储临时表的索引。 若 temp_store 为 MEMORY (2) ，临时表和索引会存储在内存中。 当 temp_store 为 FILE (1) 时，临时表和索引将存储在文件中。 可以使用 temp_store_directory pragma 来指定保存文件的路径。 指定 FILE 。当 temp_store 设置改变时， 所有已存在的表、索引、触发器以及视图都将被立即删除。

  编译时的 C 语言预处理宏 TEMP_STORE 可以覆盖 该 pragma 的设置。 下表列出它们之间的关系：

  TEMP_STORE PRAGMA
  temp_store Storage used for
  TEMP tables and indices 0 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';

  查询或改变 temp_store_directory 的值。 如果将临时表存放于文件中，它用于指定文件的存放路径。 该设置仅在当前的数据库连接中有效，当数据库重新在新的连接中打开时， 将回到其默认值。

  当改变 temp_store_directory 设置时，所有已存在的临时表、索引、 触发器以及视图都将立即删除。在实际应用中，打开数据库后应该立即设置该值。

  目录名 directory-name 应该用单引号引起来。 如果想回到默认值，将 directory-name 设为空字符串，如 PRAGMA temp_store_directory = ''。 如果路径找不到或目录 directory-name 无法写入， 会提示错误。

  默认的临时文件存放的目录依赖于操作系统。 对于 Unix/Linux/OSX 来说，默认可路径是 /var/tmp,/usr/tmp,/tmp, and 以及当前目录 current-directory中第一个可写的目录。 对于 Windows NT，默认路径由 Windows决定，通常是 C:\Documents and Settings\user-name\Local Settings\Temp\。 sqlite 创建的临时文件在打开后会被立即删除（unlink),这样，当 sqlite 进程退出时，操作系统就可以自动删除这些文件。 所以，正常状态下，使用ls 或 dir 命令是无法看到这些临时文件的。

---

查询数据库模式的 Pragma

• PRAGMA database_list;

  对每个已打开的数据库，使用数据库的信息－包括索引及数据库名等做为参数， 引发一个回调函数(仅一次）。返回的第一行将是主数据库，第二行为存放临时表的数据库信息。

• PRAGMA foreign_key_list(table-name);

  对参数表每一个相关列的外键，使用外键信息引发一个回调函数。 对每一个外键中的每一列，都将引发一次回调函数。

• PRAGMA [database].freelist_count;

  返回数据库文件中未用的页。使用一个很大的 N 值执行一个 "PRAGMA incremental_vaccum(N);" 命令将会根据该值所确定的页数来收缩数据库文件大小。

• PRAGMA index_info(index-name);

  对指定的索引相关的每一列，使用该列的信息引发回调函数， 包括列名和列号。

• PRAGMA index_list(table-name);

  对 table-name 指定表中的每一个索引,使用索引信息调用一次回调函数。 参加包括索引名以及指示索引是否唯一的标志。

• PRAGMA table_info(table-name);

  对于 table-name 所指定表的每一列， 使用列的信息调用回调函数。包括列名，数据库型，列是否可以包含NULL值， 以及列的缺省值。

---

查询或改变数据库版本的 Pragma

• PRAGMA [database.]schema_version;
  PRAGMA [database.]schema_version = integer ;
  PRAGMA [database.]user_version;
  PRAGMA [database.]user_version = integer ;

  Pragma schema_version 和 user_version 分别用于获取或设置 schema-version 和 user-version的值。 它们都是存储在数据库首部的32位的有符号整数。

  schema-version 通常仅用于sqlite 内部操作。 任何时候改变数据库模式（schema）都将会递增该值 （通过创建或删除表或索引）。每当 sqlite 执行一个查询时都会使用它。 以保证编译SQL查询时所使用schema的内部cache与实际查询数据库时是一致的。 通过 “PRAGMA schema_version” 不正确地使用该机制来修改 schema-version 的值会有潜在的危险，并可能导致程序崩溃或数据库破坏。 小心使用它！

  user-version 不是 sqlite 内部用的，可以被应用程序用于任何目的。

---

调试库的 Pragma

• PRAGMA integrity_check;
  PRAGMA integrity_check(integer)

  该命令对整个数据库做一个完整性检查。 它会寻找混乱的记录，丢失的页，格式不正确的记录，以及不完整的索引。 如果它发现任何问题，将会返回一个描述其遇到问题的字符串 （字符串有多行，每行又是一行一列）。 在分析退出前，最多后报告 integer 个错误。 integer 的默认值是 100。 如果未发现错误，则仅返回一行 "ok" 。

• PRAGMA parser_trace = ON; (1)
  PRAGMA parser_trace = OFF; (0)

  在sqlite库的内部打开或关闭 sql 分析器跟踪。 用于调试。只有在库文件编译时没有设置 NDEBUG 宏时才有效。

• PRAGMA vdbe_trace = ON; (1)
  PRAGMA vdbe_trace = OFF; (0)

  在sqlite库内部打开或关闭虚拟数据库引擎跟踪。 用于调试。详见VDBE documentation 。

• PRAGMA vdbe_listing = ON; (1)
  PRAGMA vdbe_listing = OFF; (0)

  打开或关闭虚拟机列表程序。如果开启列表， 那么所有程序的内容在执行前都会打印出来。 这就像在每个命令前自动执行 EXPLAN 一样。 打印后，语句会在正常执行。用于调试。详见 VDBE documentation