sqlite pragma

sqlite 的 pragma 命令是一個(gè)特殊的命令，可以用在 sqlite 環(huán)境內(nèi)控制各種環(huán)境變量和狀態(tài)標(biāo)志。一個(gè) pragma 值可以被讀取，也可以根據(jù)需求進(jìn)行設(shè)置。

1. 語(yǔ)法

要查詢(xún)當(dāng)前的 pragma 值，只需要提供該 pragma 的名字：

pragma pragma_name;

要為 pragma 設(shè)置一個(gè)新的值，語(yǔ)法如下：

pragma pragma_name = value;

設(shè)置模式，可以是名稱(chēng)或等值的整數(shù)，但返回的值將始終是一個(gè)整數(shù)。

2. auto_vacuum pragma

auto_vacuum pragma 獲取或設(shè)置 auto-vacuum 模式。語(yǔ)法如下：

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

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

3. cache_size pragma

cache_size pragma 可獲取或暫時(shí)設(shè)置在內(nèi)存中頁(yè)面緩存的最大尺寸。語(yǔ)法如下：

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

pages 值表示在緩存中的頁(yè)面數(shù)。內(nèi)置頁(yè)面緩存的默認(rèn)大小為 2,000 頁(yè)，最小尺寸為 10 頁(yè)。

4. case_sensitive_like pragma

case_sensitive_like pragma 控制內(nèi)置的 like 表達(dá)式的大小寫(xiě)敏感度。默認(rèn)情況下，該 pragma 為 false，這意味著，內(nèi)置的 like 操作符忽略字母的大小寫(xiě)。語(yǔ)法如下：

pragma case_sensitive_like = [true|false];

目前沒(méi)有辦法查詢(xún)?cè)?pragma 的當(dāng)前狀態(tài)。

5. count_changes pragma

count_changes pragma 獲取或設(shè)置數(shù)據(jù)操作語(yǔ)句的返回值，如 insert、update 和 delete。語(yǔ)法如下：

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

默認(rèn)情況下，該 pragma 為 false，這些語(yǔ)句不返回任何東西。如果設(shè)置為 true，每個(gè)所提到的語(yǔ)句將返回一個(gè)單行單列的表，由一個(gè)單一的整數(shù)值組成，該整數(shù)表示操作影響的行。

6. database_list pragma

database_list pragma 將用于列出了所有的數(shù)據(jù)庫(kù)連接。語(yǔ)法如下：

pragma database_list;

該 pragma 將返回一個(gè)單行三列的表格，每當(dāng)打開(kāi)或附加數(shù)據(jù)庫(kù)時(shí)，會(huì)給出數(shù)據(jù)庫(kù)中的序列號(hào)，它的名稱(chēng)和相關(guān)的文件。

7. encoding pragma

encoding pragma 控制字符串如何編碼及存儲(chǔ)在數(shù)據(jù)庫(kù)文件中。語(yǔ)法如下：

pragma encoding;
pragma encoding = format;

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

8. freelist_count pragma

freelist_count pragma 返回一個(gè)整數(shù)，表示當(dāng)前被標(biāo)記為免費(fèi)和可用的數(shù)據(jù)庫(kù)頁(yè)數(shù)。語(yǔ)法如下：

pragma [database.]freelist_count;

9. index_info pragma

index_info pragma 返回關(guān)于數(shù)據(jù)庫(kù)索引的信息。語(yǔ)法如下：

pragma [database.]index_info( index_name );

結(jié)果集將為每個(gè)包含在給出列序列的索引、表格內(nèi)的列索引、列名稱(chēng)的列顯示一行。

10. index_list pragma

index_list pragma 列出所有與表相關(guān)聯(lián)的索引。語(yǔ)法如下：

pragma [database.]index_list( table_name );

結(jié)果集將為每個(gè)給出列序列的索引、索引名稱(chēng)、表示索引是否唯一的標(biāo)識(shí)顯示一行。

11. journal_mode pragma

journal_mode pragma 獲取或設(shè)置控制日志文件如何存儲(chǔ)和處理的日志模式。語(yǔ)法如下：:

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

這里支持五種日志模式：

12. max_page_count pragma

max_page_count pragma 為數(shù)據(jù)庫(kù)獲取或設(shè)置允許的最大頁(yè)數(shù)。語(yǔ)法如下：

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

默認(rèn)值是 1,073,741,823，這是一個(gè)千兆的頁(yè)面，即如果默認(rèn) 1 kb 的頁(yè)面大小，那么數(shù)據(jù)庫(kù)中增長(zhǎng)起來(lái)的一個(gè)兆字節(jié)。

13. page_count pragma

page_count pragma 返回當(dāng)前數(shù)據(jù)庫(kù)中的網(wǎng)頁(yè)數(shù)量。語(yǔ)法如下：

pragma [database.]page_count;

數(shù)據(jù)庫(kù)文件的大小應(yīng)該是 page_count * page_size。

14. page_size pragma

page_size pragma 獲取或設(shè)置數(shù)據(jù)庫(kù)頁(yè)面的大小。語(yǔ)法如下：

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

默認(rèn)情況下，允許的尺寸是 512、1024、2048、4096、8192、16384、32768 字節(jié)。改變現(xiàn)有數(shù)據(jù)庫(kù)頁(yè)面大小的唯一方法就是設(shè)置頁(yè)面大小，然后立即 vacuum 該數(shù)據(jù)庫(kù)。

15. parser_trace pragma

parser_trace pragma 隨著它解析 sql 命令來(lái)控制打印的調(diào)試狀態(tài)，語(yǔ)法如下：

pragma parser_trace = [true|false];

默認(rèn)情況下，它被設(shè)置為 false，但設(shè)置為 true 時(shí)則啟用，此時(shí) sql 解析器會(huì)隨著它解析 sql 命令來(lái)打印出它的狀態(tài)。

16. recursive_triggers pragma

recursive_triggers pragma 獲取或設(shè)置遞歸觸發(fā)器功能。如果未啟用遞歸觸發(fā)器，一個(gè)觸發(fā)動(dòng)作將不會(huì)觸發(fā)另一個(gè)觸發(fā)。語(yǔ)法如下：

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

17. schema_version pragma

schema_version pragma 獲取或設(shè)置存儲(chǔ)在數(shù)據(jù)庫(kù)頭中的的架構(gòu)版本值。語(yǔ)法如下：

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

這是一個(gè) 32 位有符號(hào)整數(shù)值，用來(lái)跟蹤架構(gòu)的變化。每當(dāng)一個(gè)架構(gòu)改變命令執(zhí)行（比如 create... 或 drop...）時(shí)，這個(gè)值會(huì)遞增。

18. secure_delete pragma

secure_delete pragma 用來(lái)控制內(nèi)容是如何從數(shù)據(jù)庫(kù)中刪除。語(yǔ)法如下：

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

安全刪除標(biāo)志的默認(rèn)值通常是關(guān)閉的，但是這是可以通過(guò) sqlite_secure_delete 構(gòu)建選項(xiàng)來(lái)改變的。

19. sql_trace pragma

sql_trace pragma 用于把 sql 跟蹤結(jié)果轉(zhuǎn)儲(chǔ)到屏幕上。語(yǔ)法如下：

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

sqlite 必須通過(guò) sqlite_debug 指令來(lái)編譯要引用的該 pragma。

20. synchronous pragma

synchronous pragma 獲取或設(shè)置當(dāng)前磁盤(pán)的同步模式，該模式控制積極的 sqlite 如何將數(shù)據(jù)寫(xiě)入物理存儲(chǔ)。語(yǔ)法如下：

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

sqlite 支持下列同步模式：

21. temp_store pragma

temp_store pragma 獲取或設(shè)置臨時(shí)數(shù)據(jù)庫(kù)文件所使用的存儲(chǔ)模式。語(yǔ)法如下：

pragma temp_store;
pragma temp_store = mode;

sqlite 支持下列存儲(chǔ)模式：

22. temp_store_directory pragma

temp_store_directory pragma 獲取或設(shè)置用于臨時(shí)數(shù)據(jù)庫(kù)文件的位置。語(yǔ)法如下：

pragma temp_store_directory;
pragma temp_store_directory = 'directory_path';

23. user_version pragma

user_version pragma 獲取或設(shè)置存儲(chǔ)在數(shù)據(jù)庫(kù)頭的用戶(hù)自定義的版本值。語(yǔ)法如下：

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

這是一個(gè) 32 位的有符號(hào)整數(shù)值，可以由開(kāi)發(fā)人員設(shè)置，用于版本跟蹤的目的。

24. writable_schema pragma

writable_schema pragma 獲取或設(shè)置是否能夠修改系統(tǒng)表。語(yǔ)法如下：

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

如果設(shè)置了該 pragma，則表以 sqlite_ 開(kāi)始，可以創(chuàng)建和修改，包括 sqlite_master 表。使用該 pragma 時(shí)要注意，因?yàn)樗赡軐?dǎo)致整個(gè)數(shù)據(jù)庫(kù)損壞。