SQLite PRAGMA

SQLitePRAGMA— это специальная команда, которую можно использовать в среде SQLite для управления различными переменными среды и флагами состояния. Значение PRAGMA можно прочитать, а также при необходимости задать.

Синтаксис

Чтобы запросить текущее значение PRAGMA, просто укажите имя прагмы:

PRAGMA pragma_name;

Чтобы задать новое значение для PRAGMA, синтаксис следующий:

PRAGMA pragma_name = value;

Режим установки может быть именем или эквивалентным целым числом, но возвращаемое значение всегда будет целым числом.

Прагма auto_vacuum

auto_vacuumЭта прагма получает или задаёт режим auto-vacuum. Синтаксис следующий:

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

Где,modeможет быть любым из следующих:

Значение прагмыОписание
0 или NONEОтключает Auto-vacuum. Это режим по умолчанию, означающий, что размер файла базы данных не будет уменьшаться, если только команда VACUUM не будет использована вручную.
1 или FULLВключает Auto-vacuum, который полностью автоматический. В этом режиме файлу базы данных разрешено уменьшаться по мере удаления данных из базы данных.
2 или INCREMENTALВключает Auto-vacuum, но его необходимо активировать вручную. В этом режиме данные, на которые есть ссылки, поддерживаются, а свободные страницы только помещаются в список свободных. Эти страницы можно использовать в любое времяпрагмой incremental_vacuumдля перезаписи.

Прагма cache_size

cache_sizeПрагма может получать или временно задавать максимальный размер кэша страниц в памяти. Синтаксис следующий:

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

pagesЗначение представляет количество страниц в кэше. Размер встроенного кэша страниц по умолчанию составляет 2,000 страниц, минимальный размер — 10 страниц.

Прагма case_sensitive_like

case_sensitive_likeПрагма управляет учетом регистра встроенного выражения LIKE. По умолчанию эта прагма имеет значение false, что означает, что встроенный оператор LIKE игнорирует регистр букв. Синтаксис следующий:

PRAGMA case_sensitive_like = [true|false];

В настоящее время нет способа запросить текущее состояние этой прагмы.

Прагма count_changes

count_changesПрагма получает или задает возвращаемое значение операторов манипулирования данными, таких как INSERT, UPDATE и DELETE. Синтаксис следующий:

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

По умолчанию эта прагма имеет значение false, и эти операторы ничего не возвращают. Если установить true, каждый из упомянутых операторов вернет таблицу с одной строкой и одним столбцом, состоящую из одного целочисленного значения, представляющего количество строк, затронутых операцией.

Прагма database_list

database_listПрагма используется для перечисления всех подключений к базе данных. Синтаксис выглядит следующим образом:

PRAGMA database_list;

Эта прагма возвращает таблицу с одной строкой и тремя столбцами. При каждом открытии или присоединении базы данных она выдаёт порядковый номер базы данных, её имя и связанный файл.

encoding Прагма

encodingПрагма управляет тем, как строки кодируются и хранятся в файле базы данных. Синтаксис выглядит следующим образом:

PRAGMA encoding;
PRAGMA encoding = format;

Значением формата может быть одно из UTF-8, UTF-16le или UTF-16be.

freelist_count Прагма

freelist_countПрагма возвращает целое число, представляющее количество страниц базы данных, в настоящее время помеченных как свободные и доступные. Синтаксис выглядит следующим образом:

PRAGMA [database.]freelist_count;

index_info Прагма

index_infoПрагма возвращает информацию об индексах базы данных. Синтаксис выглядит следующим образом:

PRAGMA [database.]index_info( index_name );

Набор результатов отобразит по одной строке для каждого столбца, содержащегося в заданном индексе, включая порядок столбца, индекс столбца в таблице и имя столбца.

index_list Прагма

index_listПрагма перечисляет все индексы, связанные с таблицей. Синтаксис выглядит следующим образом:

PRAGMA [database.]index_list( table_name );

Результирующий набор будет содержать по одной строке для каждого индекса, показывая порядковый номер индекса, имя индекса и идентификатор, указывающий, является ли индекс уникальным.

journal_mode Pragma

journal_modeЭта прагма получает или задаёт режим журнала, который управляет тем, как файлы журнала хранятся и обрабатываются. Синтаксис следующий:

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

Здесь поддерживаются пять режимов журнала:

Значение прагмыОписание
DELETEРежим по умолчанию. В этом режиме файл журнала будет удалён в конце транзакции.
TRUNCATEФайл журнала усекается до нуля байт.
PERSISTФайл журнала остаётся на месте, но заголовок перезаписывается, чтобы указать, что журнал больше не действителен.
MEMORYЗаписи журнала хранятся в памяти, а не на диске.
OFFЗаписи журнала не ведутся.

Прагма max_page_count

max_page_countПрагма получает или задает максимальное количество страниц, разрешенное для базы данных. Синтаксис следующий:

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

Значение по умолчанию — 1,073,741,823, что составляет гигабайт страниц. То есть при размере страницы по умолчанию 1 KB база данных может вырасти до одного терабайта.

Прагма page_count

page_countПрагма возвращает количество страниц в текущей базе данных. Синтаксис следующий:

PRAGMA [database.]page_count;

Размер файла базы данных должен быть page_count * page_size.

Прагма page_size

page_sizeПрагма получает или задает размер страниц базы данных. Синтаксис следующий:

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

По умолчанию допустимые размеры: 512, 1024, 2048, 4096, 8192, 16384 и 32768 байт. Единственный способ изменить размер страницы существующей базы данных — установить размер страницы и затем сразу VACUUM базу данных.

Прагма parser_trace

parser_traceПрагма управляет выводом отладочного состояния при разборе команд SQL. Синтаксис следующий:

PRAGMA parser_trace = [true|false];

По умолчанию она установлена в false, но включается при установке в true. В этом случае анализатор SQL будет выводить свое состояние при разборе команд SQL.

recursive_triggers Прагма

recursive_triggersПрагма получает или задаёт функцию рекурсивных триггеров. Если рекурсивные триггеры не включены, действие триггера не будет запускать другой триггер. Синтаксис следующий:

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

schema_version Прагма

schema_versionПрагма получает или задаёт значение версии схемы, хранящееся в заголовке базы данных. Синтаксис следующий:

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

Это 32-битное целое число со знаком, используемое для отслеживания изменений схемы. Всякий раз, когда выполняется команда, изменяющая схему (например, CREATE... или DROP...), это значение увеличивается.

secure_delete Прагма

secure_deleteПрагма используется для управления тем, как содержимое удаляется из базы данных. Синтаксис следующий:

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

Значение флага безопасного удаления по умолчанию обычно отключено, но это можно изменить с помощью опции сборки SQLITE_SECURE_DELETE.

sql_trace Прагма

sql_traceПрагма используется для вывода результатов трассировки SQL на экран. Синтаксис следующий:

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

SQLite должен быть скомпилирован с директивой SQLITE_DEBUG, чтобы использовать эту прагму.

synchronous Прагма

synchronousПрагма получает или задаёт текущий режим синхронизации диска, который управляет тем, насколько агрессивно SQLite записывает данные на физический носитель. Синтаксис следующий:

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

SQLite поддерживает следующие режимы синхронизации:

Значение прагмыОписание
0 или OFFСинхронизация не выполняется.
1 или NORMALСинхронизировать после каждой последовательности критических операций с диском.
2 или FULLСинхронизировать после каждой критической операции с диском.

Прагма temp_store

temp_storeПрагма получает или задаёт режим хранения, используемый для временных файлов базы данных. Синтаксис следующий:

PRAGMA temp_store;
PRAGMA temp_store = mode;

SQLite поддерживает следующие режимы хранения:

Значение прагмыОписание
0 или DEFAULTПо умолчанию использует режим времени компиляции. Обычно FILE.
1 или FILEИспользует файловое хранилище.
2 или MEMORYИспользует хранение в памяти.

temp_store_directory Прагма

temp_store_directoryПрагма получает или задает расположение, используемое для временных файлов базы данных. Синтаксис следующий:

PRAGMA temp_store_directory;
PRAGMA temp_store_directory = 'directory_path';

user_version Прагма

user_versionПрагма получает или задает определяемое пользователем значение версии, хранящееся в заголовке базы данных. Синтаксис следующий:

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

Это 32-битное знаковое целочисленное значение, которое разработчики могут установить для отслеживания версий.

writable_schema Прагма

writable_schemaПрагма получает или задает, можно ли изменять системные таблицы. Синтаксис следующий:

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

Если этот pragma установлен, можно создавать и изменять таблицы, начинающиеся с sqlite_, включая таблицу sqlite_master. Используйте этот pragma с осторожностью, так как это может привести к повреждению всей базы данных.

Другие расширения