9.27. Функции для системного администрирования
- 9.27.1. Функции для управления конфигурацией
- 9.27.2. Функции для передачи сигналов серверу
- 9.27.3. Функции управления резервным копированием
- 9.27.4. Функции управления восстановлением
- 9.27.5. Функции синхронизации снимков
- 9.27.6. Функции управления репликацией
- 9.27.7. Функции управления объектами баз данных
- 9.27.8. Функции обслуживания индексов
- 9.27.9. Функции для работы с обычными файлами
- 9.27.10. Функции управления рекомендательными блокировками
- 9.27.11. Функции управления сжатием
- 9.27.12. Опорные функции журнала операций
- 9.27.13. Отладочные функции
- 9.27.2. Функции для передачи сигналов серверу
Функции, описанные в этом разделе, предназначены для контроля и управления сервером Postgres Pro.
9.27.1. Функции для управления конфигурацией
В Таблице 9.83 показаны функции, позволяющие получить и изменить значения параметров конфигурации выполнения.
Таблица 9.83. Функции для управления конфигурацией
Функция Описание Пример(ы) |
|---|
Выдаёт текущее значение параметра
|
Устанавливает для параметра
|
Устанавливает в обслуживающем процессе с заданным идентификатором один или несколько параметров, указываемых в строке Если дополнительный |
Загружает библиотеку с указанным именем в процесс с заданным идентификатором. За один вызов функции можно загрузить только одну библиотеку. При запуске без привилегий суперпользователя функция Если дополнительный |
Функции pg_backend_set_config и pg_backend_load_library предназначены для изменения параметров конфигурации и загрузки общих библиотек в другие сеансы. Это может быть полезно для трассировки сеансов с необычным поведением. Во избежание угроз безопасности эти функции разрешено вызывать только суперпользователю.
Примечание
Эту функциональность нельзя использовать со встроенным пулом соединений, описанным в Главе 33.
В случаях сбоя при изменении конфигурации функцией pg_backend_set_config или при загрузке библиотеки функцией pg_backend_load_library в целевом процессе происходит ошибка, и текущая команда в этом процессе прерывается.
Рассмотрим следующие примеры:
SELECT pg_backend_set_config(pg_backend_pid(), 'statement_timeout=10000');
pg_backend_set_config
-----------------------
t
(1 row)
SELECT pg_backend_set_config(pg_backend_pid(),
'statement_timeout=20000
lock_timeout=10000');
pg_backend_set_config
-----------------------
t
(1 row)
SELECT pg_backend_set_config(pg_backend_pid(), 'fsync=on');
ERROR: parameter "fsync" cannot be changed now
SELECT pg_backend_set_config(pg_backend_pid(), 'log_min_messages=INFO');
ERROR: permission denied to set parameter "log_min_messages"SELECT pg_backend_load_library(pg_backend_pid(), 'pgoutput'); pg_backend_load_library ------------------------- t (1 row)
Если параметр config, переданный функции pg_backend_set_config, содержит синтаксическую ошибку, функция возвращает соответствующее сообщение об ошибке.
Рассмотрим следующий пример:
SELECT pg_backend_set_config(pg_backend_pid(), 'test_param', 100000); ERROR: syntax error in file "base/pgsql_tmp/pgsql_tmp87011.4" line 0, near end of line
9.27.2. Функции для передачи сигналов серверу
Функции, перечисленные в Таблице 9.84, позволяют передавать управляющие сигналы другим серверным процессам. Вызывать эти функции по умолчанию разрешено только суперпользователям, но доступ к ним можно дать и другим пользователям командой GRANT, кроме явно отмеченных исключений.
Каждая из этих функций возвращает true при успешном завершении и false в противном случае.
Таблица 9.84. Функции для передачи сигналов серверу
pg_cancel_backend и pg_terminate_backend передают сигналы (SIGINT и SIGTERM, соответственно) серверному процессу с заданным кодом PID. Код активного процесса можно получить из столбца pid представления pg_stat_activity или просмотрев на сервере процессы с именем postgres (используя ps в Unix или Диспетчер задач в Windows). Роль пользователя активного процесса можно узнать в столбце usename представления pg_stat_activity.
9.27.3. Функции управления резервным копированием
Функции, перечисленные в Таблице 9.85, предназначены для выполнения резервного копирования «на ходу». Эти функции нельзя выполнять во время восстановления (за исключением немонопольных вариантов pg_start_backup и pg_stop_backup, а также функций pg_is_in_backup, pg_backup_start_time и pg_wal_lsn_diff).
Подробнее практическое применение этих функций описывается в Разделе 25.3.
Таблица 9.85. Функции управления резервным копированием
Функция Описание |
|---|
Создаёт в журнале предзаписи именованный маркер, который можно использовать как цель при восстановлении, и возвращает соответствующую ему позицию в журнале. Полученное имя затем можно указать в параметре recovery_target_name, определив тем самым точку, до которой будет выполняться восстановление. Учтите, что если будет создано несколько точек восстановления с одним именем, восстановление остановится на первой точке с этим именем. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям. |
Выдаёт текущую позицию сброса данных в журнале предзаписи (см. примечания ниже). |
Выдаёт текущую позицию добавления в журнале предзаписи (см. примечания ниже). |
Выдаёт текущую позицию записи в журнале предзаписи (см. примечания ниже). |
Подготавливает сервер к резервному копированию «на лету». Единственный обязательный параметр задаёт произвольную пользовательскую метку резервной копии. (Обычно это имя, которое получит файл резервной копии.) Если необязательный второй параметр задан и имеет значение При копировании в монопольном режиме эта функция записывает файл метки ( По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям. |
Завершает процедуру немонопольного или монопольного копирования «на лету». Значение параметра У этой функции есть также необязательный второй параметр типа При выполнении на ведущем эта функция также создаёт файл истории резервного копирования в области архива журнала предзаписи. В этом файле для данной резервной копии сохраняется метка, заданная при вызове В результате эта функция выдаёт единственную запись. Столбец По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям. |
Завершает процедуру монопольного копирования «на лету». Вызов этой упрощённой вариации равнозначен По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям. |
Возвращает true, если в данный момент выполняется исключительное резервное копирование. |
Выдаёт время начала исключительного резервного копирования, если оно выполняется в данный момент, иначе — |
Производит принудительное переключение журнала предзаписи на новый файл, что позволяет архивировать текущий (в предположении, что выполняется непрерывная архивация). Результат функции — конечная позиция в только что законченном файле журнала предзаписи + 1. Если с момента последнего переключения файлов не было активности, отражающейся в журнале предзаписи, По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям. |
Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла WAL. |
Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла и байтовое смещение в нём. |
Вычисляет разницу в байтах ( |
pg_current_wal_lsn выводит текущую позицию записи в журнале предзаписи в том же формате, что и вышеописанные функции. pg_current_wal_insert_lsn подобным образом выводит текущую позицию добавления, а pg_current_wal_flush_lsn — позицию сброса данных журнала. Позицией добавления называется «логический» конец журнала предзаписи в любой момент времени, тогда как позиция записи указывает на конец данных, фактически вынесённых из внутренних буферов сервера, а позиция сброса показывает, до какого места данные считаются сохранёнными в надёжном хранилище. Позиция записи отмечает конец данных, которые может видеть снаружи внешний процесс, и именно она представляет интерес при копировании частично заполненных файлов журнала. Позиция добавления и позиция сброса выводятся в основном для отладки серверной части. Все эти функции выполняются в режиме «только чтение» и не требуют прав суперпользователя.
Используя функцию pg_walfile_name_offset, из значения pg_lsn можно получить имя соответствующего ему файла журнала предзаписи и байтовое смещение в этом файле. Например:
postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());
file_name | file_offset
--------------------------+-------------
00000001000000000000000D | 4039624
(1 row) Родственная ей функция pg_walfile_name извлекает только имя файла журнала предзаписи. Когда заданная позиция в журнале предзаписи находится ровно на границе файлов, обе эти функции возвращают имя предыдущего файла. Обычно это поведение предпочтительно при архивировании журнала предзаписи, так как именно предыдущий файл является последним подлежащим архивации.
9.27.4. Функции управления восстановлением
Функции, показанные в Таблице 9.86, предоставляют сведения о текущем состоянии ведомого сервера. Эти функции могут выполняться как во время восстановления, так и в обычном режиме работы.
Таблица 9.86. Функции для получения информации о восстановлении
Функции, перечисленные в Таблице 9.87 управляют процессом восстановления. Вызывать их в другое время нельзя.
Таблица 9.87. Функции управления восстановлением
Функции pg_wal_replay_pause и pg_wal_replay_resume нельзя выполнять в процессе повышения. Если повышение запрашивается, когда восстановление приостановлено, сервер выходит из состояния паузы и продолжает процедуру повышения.
Когда потоковая репликация отключена, пауза при восстановлении может длиться сколь угодно долго без каких-либо проблем. Если же потоковая репликация осуществляется, новые записи WAL продолжат поступать и заполнят весь диск рано или поздно, в зависимости от длительности паузы, интенсивности записи в WAL и объёма свободного пространства.
9.27.5. Функции синхронизации снимков
Postgres Pro позволяет синхронизировать снимки состояния между сеансами баз данных. Снимок состояния определяет, какие данные видны транзакции, работающей с этим снимком. Синхронизация снимков необходима, когда в двух или более сеансах нужно видеть одно и то же содержимое базы данных. Если в двух сеансах транзакции запускаются независимо, всегда есть вероятность, что некая третья транзакция будет зафиксирована между командами START TRANSACTION для первых двух, и в результате в одном сеансе будет виден результат третьей, а в другом — нет.
Для решения этой проблемы Postgres Pro позволяет транзакции экспортировать снимок состояния, с которым она работает. Пока экспортирующая этот снимок транзакция выполняется, другие транзакции могут импортировать его и, таким образом, увидеть абсолютно то же состояние базы данных, что видит первая транзакция. Но учтите, что любые изменения, произведённые этими транзакциями, будут не видны для других, как это и должно быть с изменениями в незафиксированных транзакциях. Таким образом, транзакции синхронизируют только начальное состояние данных, а последующие производимые в них изменения изолируются как обычно.
Снимки состояния экспортируются с помощью функции pg_export_snapshot, показанной в Таблице 9.88, и импортируются командой SET TRANSACTION.
Таблица 9.88. Функции синхронизации снимков
Функция Описание |
|---|
Сохраняет текущий снимок состояния транзакции и возвращает строку типа Если необходимо, транзакция может экспортировать несколько снимков. Заметьте, что это имеет смысл только для транзакций уровня |
9.27.6. Функции управления репликацией
В Таблице 9.89 показаны функции, предназначенные для управления механизмом репликации и взаимодействия с ним. Чтобы изучить этот механизм детальнее, обратитесь к Подразделу 26.2.5, Подразделу 26.2.6 и Главе 52. Использовать эти функции для источников репликации разрешено только суперпользователям, а для слотов репликации — только суперпользователям и пользователям, имеющим право REPLICATION.
Многие из этих функций соответствуют командам в протоколе репликации; см. Раздел 55.4.
Функции, описанные в Подразделе 9.27.3, Подразделе 9.27.4 и Подразделе 9.27.5, также имеют отношение к репликации.
Таблица 9.89. Функции управления репликацией
Функция Описание |
|---|
Создаёт новый физический слот репликации с именем |
Удаляет физический или логический слот репликации с именем |
Создаёт новый логический (декодирующий) слот репликации с именем |
Копирует существующий слот физической репликации с именем |
Копирует существующий слот логической репликации с именем |
Возвращает изменения в слоте |
Работает так же, как функция |
Работает так же, как функция |
Работает аналогично функции |
Продвигает текущую подтверждённую позицию слота репликации с именем |
Создаёт источник репликации с заданным внешним именем и возвращает назначенный ему внутренний идентификатор. |
Удаляет ранее созданный источник репликации, в том числе связанную информацию о воспроизведении. |
Ищет источник репликации по имени и возвращает внутренний идентификатор. Если такой источник не находится, возвращает |
Помечает текущий сеанс как воспроизводящий изменения из указанного источника, что позволяет отслеживать процесс воспроизведения. Может применяться, только если в текущий момент источник ещё не выбран. Для отмены этого действия вызовите |
Отменяет действие |
Возвращает true, если в текущем сеансе выбран источник репликации. |
Возвращает позицию воспроизведения для источника репликации, выбранного в текущем сеансе. Параметр |
Помечает текущую транзакцию как воспроизводящую транзакцию, зафиксированную с указанным LSN и временем. Может вызываться только после того, как источник репликации был выбран в результате вызова |
Отменяет действие |
Устанавливает положение репликации для заданного узла в указанную позицию. Это в основном полезно для установки начальной позиции или новой позиции после изменения конфигурации и подобных действий. Но учтите, что неосторожное использование этой функции может привести к несогласованности реплицированных данных. |
Выдаёт позицию воспроизведения для заданного источника репликации. Параметр |
Генерирует сообщение логического декодирования. Её можно использовать для передачи через WAL произвольных сообщений модулям логического декодирования. Параметр |
9.27.7. Функции управления объектами баз данных
Функции, показанные в Таблице 9.90, вычисляют объём, который занимают на диске объекты базы данных, и помогают представить полученные результаты. Все эти функции выдают размеры в байтах. Если им передаётся OID, не соответствующий существующему объекту, они возвращают NULL.
Таблица 9.90. Функции получения размера объектов БД
Функция Описание |
|---|
Показывает, сколько байт занимает при хранении отдельное значение. Если эта функция применяется непосредственно к значению в столбце таблицы, в результате отражается эффект возможного сжатия. |
Вычисляет общий объём, который занимает на диске база данных с указанным именем или OID. Для использования этой функции необходимо иметь право |
Вычисляет общий объём, который занимают на диске индексы, связанные с указанной таблицей. |
Вычисляет объём, который занимает на диске один «слой» заданного отношения. (Заметьте, что в большинстве случаев удобнее использовать более высокоуровневые функции
|
Принимает OID или имя временной таблицы и возвращает общий размер в байтах слоя |
Преобразует размер в человеко-ориентированном формате (который выдаёт |
Преобразует размер в байтах в более понятный человеку формат с единицами измерения размера (bytes, kB, MB, GB или TB, в зависимости от значения). Заметьте, что эти единицы определяются как степени 2, а не 10, так что 1kB — это 1024 байта, 1MB — 10242 = 1048576 байт и т. д. |
Вычисляет объём, который занимает на диске данная таблица, за исключением индексов (но включая её TOAST-таблицу (если она есть), карту свободного места и карту видимости). |
Вычисляет общий объём, который занимает на диске табличное пространство с заданным именем или OID. Для использования этой функции требуется иметь право |
Вычисляет общий объём, который занимает на диске заданная таблица, включая все её индексы и данные TOAST. Результат этой функции равен значению |
Вышеописанные функции, работающие с таблицами или индексами, принимают аргумент типа regclass, который представляет собой просто OID таблицы или индекса в системном каталоге pg_class. Однако вам не нужно вручную вычислять OID, так как процедура ввода значения regclass может сделать это за вас. Для этого достаточно записать имя таблицы в апострофах, как обычную текстовую константу. В соответствии с правилами обработки обычных имён SQL, если имя таблицы не заключено в кавычки, эта строка будет переведена в нижний регистр.
Функции, перечисленные в Таблице 9.91, помогают определить, в каких файлах на диске хранятся объекты базы данных.
Таблица 9.91. Функции определения расположения объектов
Функция Описание |
|---|
Выдаёт номер «файлового узла», связанного с заданным объектом. Файловым узлом называется основной компонент имени файла, используемого для хранения данных (подробнее это описано в Разделе 70.1). Для большинства отношений этот номер совпадает со значением |
Выдаёт полный путь к файлу отношения (относительно каталога данных |
Выдаёт OID отношения, которое хранится в табличном пространстве, заданном по OID, в указанном файловом узле. По сути эта функция является обратной к |
В Таблица 9.92 перечислены функции, предназначенные для управления правилами сортировки.
Таблица 9.92. Функции управления правилами сортировки
Функция Описание |
|---|
Возвращает действующую версию объекта правила сортировки, которая в настоящее время установлена в операционной системе. Если она отличается от значения в |
Добавляет правила сортировки в системный каталог |
В Таблице 9.93 перечислены функции, предоставляющие информацию о структуре секционированных таблиц.
Таблица 9.93. Функции получения информации о секционировании
Например, чтобы определить общий размер данных, содержащихся в секционированной таблице measurement, можно использовать следующий запрос:
SELECT pg_size_pretty(sum(pg_relation_size(relid))) AS total_size
FROM pg_partition_tree('measurement');9.27.8. Функции обслуживания индексов
В Таблице 9.94 перечислены функции, предназначенные для обслуживания индексов. (Заметьте, что задачи обслуживания обычно выполняются автоматически в ходе автоочистки; пользоваться данными функциями требуется только в особых случаях.) Выполнять эти функции во время восстановления нельзя. Использовать их разрешено только суперпользователям и владельцу определённого индекса.
Таблица 9.94. Функции обслуживания индексов
Функция Описание |
|---|
Сканирует указанный BRIN-индекс в поисках зон страниц в базовой таблице, ещё не обобщённых в индексе; для каждой такой зоны в результате сканирования этих страниц создаётся новый обобщающий кортеж в индексе. Возвращает эта функция число вставленных в индекс обобщающих записей о зонах страниц. |
Обобщает зону страниц, охватывающую данный блок, если она ещё не была обобщена. Эта функция подобна |
Удаляет из BRIN-индекса кортеж, который обобщает зону страниц, охватывающую данный блок таблицы, если такой кортеж имеется. |
Очищает очередь указанного GIN-индекса, массово перемещая элементы из неё в основную структуру данных GIN, и возвращает число страниц, убранных из очереди. Если для обработки ей передаётся индекс GIN, построенный с отключённым параметром |
9.27.9. Функции для работы с обычными файлами
Функции, перечисленные в Таблице 9.95, предоставляют прямой доступ к файлам, находящимся на сервере. Обычным пользователям, не включённым в роль pg_read_server_files, они позволяют обращаться только к файлам в каталоге кластера баз данных и в каталоге log_directory. Для файлов в каталоге кластера этим функциям передаётся относительный путь, а для файлов журнала — путь, соответствующий значению параметра log_directory.
Заметьте, что пользователи, обладающие правом EXECUTE для pg_read_file() или связанных функций, имеют возможность читать любой файл на сервере, который может прочитать серверный процесс; на эти функции не действуют никакие ограничения доступа внутри базы данных. В частности это означает, что пользователь с такими правами может прочитать содержимое таблицы pg_authid, в которой хранятся данные аутентификации, равно как и любой другой файл в базе данных. Таким образом, разрешать доступ к этим функциям следует с большой осторожностью.
Некоторые из этих функций принимают необязательный параметр missing_ok, который определяет их поведение в случае отсутствия файла или каталога. Если он равен true, функция возвращает NULL или пустой набор данных. Если же он равен false, в указанном случае выдаётся ошибка. Значение по умолчанию — false.
Таблица 9.95. Функции для работы с обычными файлами
9.27.10. Функции управления рекомендательными блокировками
Функции, перечисленные в Таблице 9.96, предназначены для управления рекомендательными блокировками. Подробнее об их использовании можно узнать в Подразделе 13.3.5.
Все эти функции предназначены для оперирования блокировками ресурсов, определяемых приложением и задаваемых одним 64-битным или двумя 32-битными ключами (заметьте, что пространства этих ключей не пересекаются). Если конфликтующую блокировку с тем же идентификатором уже удерживает другой сеанс, эти функции либо дожидаются освобождения ресурса, либо выдают в результате false, в зависимости от вида функции. Блокировки могут быть как исключительными, так и разделяемыми — разделяемая блокировка не конфликтует с другими разделяемыми блокировками того же ресурса, но конфликтует с исключительными. Блокировки могут устанавливаться на сеансовом уровне (тогда они удерживаются до момента освобождения или до завершения сеанса) и на транзакционном (тогда они удерживаются до конца текущей транзакции, освободить их вручную нет возможности). Когда поступает несколько запросов на блокировку сеансового уровня, они накапливаются, так что если один идентификатор ресурса был заблокирован три раза, должны поступить три запроса на освобождение блокировки, чтобы ресурс был разблокирован до завершения сеанса.
Таблица 9.96. Функции управления рекомендательными блокировками
9.27.11. Функции управления сжатием
Функции, приведённые в Таблице 9.97, выдают информацию о состоянии и активности CFS, а также управляют сборкой мусора CFS.
Таблица 9.97. Функции управления сжатием
| Имя | Тип результата | Описание |
|---|---|---|
| integer | Запускает сборку мусора с заданным числом рабочих процессов. Вы можете запустить её вручную с помощью этой функции, только если фоновая сборка мусора отключена. |
| boolean | Включает/отключает фоновый процесс сборки мусора. Для управления вы также можете использовать переменную конфигурации cfs_gc. |
| integer | Выполняет сборку мусора для заданной таблицы. Эта функция возвращает число обработанных сегментов. |
| text | Выводит версию CFS и используемый алгоритм сжатия. |
| float8 | Оценивает возможный эффект от сжатия таблицы. Возвращает средний коэффициент сжатия для первых десяти процентов блоков отношения (но не более 100 блоков). |
| float8 | Возвращает фактический коэффициент сжатия для всех сегментов сжатого отношения. |
| float8 | Возвращает средний коэффициент фрагментации для файлов заданного отношения. |
| int64 | Возвращает общий размер страниц, обработанных механизмом CFS в процессе сборки мусора. |
| int64 | Возвращает число страниц, обработанных механизмом CFS в процессе сборки мусора. |
| int64 | Возвращает число файлов, сжатых механизмом CFS в процессе сборки мусора. |
| int64 | Возвращает число файлов, просканированных механизмом CFS в процессе сборки мусора. |
9.27.12. Опорные функции журнала операций
В журнале операций хранится информация о критически важных системных событиях, таких как обновление, выполнение pg_resetwal и т. п. Эта информация не представляет особого интереса для обычного пользователя, но важна для осуществления технической поддержки со стороны поставщика. Запись в журнал операций производится только на системном уровне (без каких-либо действий со стороны пользователя), а для его чтения используются функции SQL. Функция, показанная в Таблица 9.98, читает журнал операций.
Таблица 9.98. Опорные функции журнала операций
Функция Описание |
|---|
Здесь:
Эта системная функция создаётся автоматически для новых баз данных, а для существующих баз данных должна создаваться следующим образом: CREATE OR REPLACE FUNCTION
pg_operation_log(
OUT event text,
OUT edition text,
OUT version text,
OUT lsn pg_lsn,
OUT last timestamptz,
OUT count int4)
RETURNS SETOF record
LANGUAGE INTERNAL
STABLE STRICT PARALLEL SAFE
AS 'pg_operation_log'; |
Ниже представлен пример вывода для функции pg_operation_log:
select * from pg_operation_log(); event | edition | version | lsn | last | count ------------+---------+---------+-----------+------------------------+------- startup | vanilla | 10.22.0 | 0/8000028 | 2022-10-27 23:06:27+03 | 1 pg_upgrade | 1c | 15.0.0 | 0/8000028 | 2022-10-27 23:06:27+03 | 1 startup | 1c | 15.0.0 | 0/80001F8 | 2022-10-27 23:06:53+03 | 2 (3 rows)
Примечание
Если журнал операций пуст, то при обновлении перед записью pg_upgrade сначала записывается событие startup с предыдущим значением version, имеющим следующие особенности: вместо версии патча (третья цифра в номере версии) всегда устанавливается ноль, поскольку в pg_upgrade нет информации о версии патча ни для одной редакции (1c, std, ent). При обновлении с 1c или vanilla невозможно выяснить, к какой из этих редакций относится база данных до обновления, поэтому для записи startup используется редакция vanilla.
9.27.13. Отладочные функции
Функция, показанная в Таблице 9.99, может быть полезна для низкоуровневых операций, например в целях отладки или исследования испорченных баз данных Postgres Pro.
Таблица 9.99. Функции синхронизации снимков
| Имя | Тип результата | Описание |
|---|---|---|
| void | Отключает действие правил MVCC в рамках текущей транзакции, что позволяет видеть в ней все версии данных. |
Применяйте pg_snapshot_any крайне осторожно. Выполнять её следует в транзакции с уровнем изоляции REPEATABLE READ или выше, в противном случае следующий же запрос заменит выбранный снимок новым. Выполнять её могут только суперпользователи.
Примечание
Если ваш кластер БД создавался сервером версии, в которой этой функции ещё не было, определите её следующей командой:
CREATE FUNCTION pg_snapshot_any() RETURNS void AS 'pg_snapshot_any' LANGUAGE internal;
9.27. System Administration Functions
- 9.27.1. Configuration Settings Functions
- 9.27.2. Server Signaling Functions
- 9.27.3. Backup Control Functions
- 9.27.4. Recovery Control Functions
- 9.27.5. Snapshot Synchronization Functions
- 9.27.6. Replication Management Functions
- 9.27.7. Database Object Management Functions
- 9.27.8. Index Maintenance Functions
- 9.27.9. Generic File Access Functions
- 9.27.10. Advisory Lock Functions
- 9.27.11. Compression Control Functions
- 9.27.12. Operation Log Support Functions
- 9.27.13. Debugging Functions
- 9.27.2. Server Signaling Functions
The functions described in this section are used to control and monitor a Postgres Pro installation.
9.27.1. Configuration Settings Functions
Table 9.83 shows the functions available to query and alter run-time configuration parameters.
Table 9.83. Configuration Settings Functions
Function Description Example(s) |
|---|
Returns the current value of the setting
|
Sets the parameter
|
Sets one or more parameters provided in the If the optional |
Loads the library with the provided name for the backend with the specified PID. You can load only one library at a time. When run without superuser privileges, If the optional |
Functions pg_backend_set_config and pg_backend_load_library are designed to set configuration parameters and load shared libraries in other sessions, which may be useful for tracing sessions with unexpected behavior. To avoid potential security issues, these functions can only be called by a superuser.
Note
This functionality cannot be used together with the built-in connection pooler described in Chapter 33.
If a configuration update by pg_backend_set_config or a library loading by pg_backend_load_library fails, an error occurs on the target backend, and the current command on this backend is aborted.
Consider the following examples:
SELECT pg_backend_set_config(pg_backend_pid(), 'statement_timeout=10000');
pg_backend_set_config
-----------------------
t
(1 row)
SELECT pg_backend_set_config(pg_backend_pid(),
'statement_timeout=20000
lock_timeout=10000');
pg_backend_set_config
-----------------------
t
(1 row)
SELECT pg_backend_set_config(pg_backend_pid(), 'fsync=on');
ERROR: parameter "fsync" cannot be changed now
SELECT pg_backend_set_config(pg_backend_pid(), 'log_min_messages=INFO');
ERROR: permission denied to set parameter "log_min_messages"
SELECT pg_backend_load_library(pg_backend_pid(), 'pgoutput'); pg_backend_load_library ------------------------- t (1 row)
If the config parameter passed to pg_backend_set_config contains a syntax error, the function returns a corresponding error message.
Consider the following example:
SELECT pg_backend_set_config(pg_backend_pid(), 'test_param', 100000); ERROR: syntax error in file "base/pgsql_tmp/pgsql_tmp87011.4" line 0, near end of line
9.27.2. Server Signaling Functions
The functions shown in Table 9.84 send control signals to other server processes. Use of these functions is restricted to superusers by default but access may be granted to others using GRANT, with noted exceptions.
Each of these functions returns true if successful and false otherwise.
Table 9.84. Server Signaling Functions
pg_cancel_backend and pg_terminate_backend send signals (SIGINT or SIGTERM respectively) to backend processes identified by process ID. The process ID of an active backend can be found from the pid column of the pg_stat_activity view, or by listing the postgres processes on the server (using ps on Unix or the Task Manager on Windows). The role of an active backend can be found from the usename column of the pg_stat_activity view.
9.27.3. Backup Control Functions
The functions shown in Table 9.85 assist in making on-line backups. These functions cannot be executed during recovery (except non-exclusive pg_start_backup, non-exclusive pg_stop_backup, pg_is_in_backup, pg_backup_start_time and pg_wal_lsn_diff).
For details about proper usage of these functions, see Section 25.3.
Table 9.85. Backup Control Functions
Function Description |
|---|
Creates a named marker record in the write-ahead log that can later be used as a recovery target, and returns the corresponding write-ahead log location. The given name can then be used with recovery_target_name to specify the point up to which recovery will proceed. Avoid creating multiple restore points with the same name, since recovery will stop at the first one whose name matches the recovery target. This function is restricted to superusers by default, but other users can be granted EXECUTE to run the function. |
Returns the current write-ahead log flush location (see notes below). |
Returns the current write-ahead log insert location (see notes below). |
Returns the current write-ahead log write location (see notes below). |
Prepares the server to begin an on-line backup. The only required parameter is an arbitrary user-defined label for the backup. (Typically this would be the name under which the backup dump file will be stored.) If the optional second parameter is given as When used in exclusive mode, this function writes a backup label file ( This function is restricted to superusers by default, but other users can be granted EXECUTE to run the function. |
Finishes performing an exclusive or non-exclusive on-line backup. The There is an optional second parameter of type When executed on a primary, this function also creates a backup history file in the write-ahead log archive area. The history file includes the label given to The result of the function is a single record. The This function is restricted to superusers by default, but other users can be granted EXECUTE to run the function. |
Finishes performing an exclusive on-line backup. This simplified version is equivalent to This function is restricted to superusers by default, but other users can be granted EXECUTE to run the function. |
Returns true if an on-line exclusive backup is in progress. |
Returns the start time of the current on-line exclusive backup if one is in progress, otherwise |
Forces the server to switch to a new write-ahead log file, which allows the current file to be archived (assuming you are using continuous archiving). The result is the ending write-ahead log location plus 1 within the just-completed write-ahead log file. If there has been no write-ahead log activity since the last write-ahead log switch, This function is restricted to superusers by default, but other users can be granted EXECUTE to run the function. |
Converts a write-ahead log location to the name of the WAL file holding that location. |
Converts a write-ahead log location to a WAL file name and byte offset within that file. |
Calculates the difference in bytes ( |
pg_current_wal_lsn displays the current write-ahead log write location in the same format used by the above functions. Similarly, pg_current_wal_insert_lsn displays the current write-ahead log insertion location and pg_current_wal_flush_lsn displays the current write-ahead log flush location. The insertion location is the “logical” end of the write-ahead log at any instant, while the write location is the end of what has actually been written out from the server's internal buffers, and the flush location is the last location known to be written to durable storage. The write location is the end of what can be examined from outside the server, and is usually what you want if you are interested in archiving partially-complete write-ahead log files. The insertion and flush locations are made available primarily for server debugging purposes. These are all read-only operations and do not require superuser permissions.
You can use pg_walfile_name_offset to extract the corresponding write-ahead log file name and byte offset from a pg_lsn value. For example:
postgres=# SELECT * FROM pg_walfile_name_offset(pg_stop_backup());
file_name | file_offset
--------------------------+-------------
00000001000000000000000D | 4039624
(1 row)
Similarly, pg_walfile_name extracts just the write-ahead log file name. When the given write-ahead log location is exactly at a write-ahead log file boundary, both these functions return the name of the preceding write-ahead log file. This is usually the desired behavior for managing write-ahead log archiving behavior, since the preceding file is the last one that currently needs to be archived.
9.27.4. Recovery Control Functions
The functions shown in Table 9.86 provide information about the current status of a standby server. These functions may be executed both during recovery and in normal running.
Table 9.86. Recovery Information Functions
The functions shown in Table 9.87 control the progress of recovery. These functions may be executed only during recovery.
Table 9.87. Recovery Control Functions
pg_wal_replay_pause and pg_wal_replay_resume cannot be executed while a promotion is ongoing. If a promotion is triggered while recovery is paused, the paused state ends and promotion continues.
If streaming replication is disabled, the paused state may continue indefinitely without a problem. If streaming replication is in progress then WAL records will continue to be received, which will eventually fill available disk space, depending upon the duration of the pause, the rate of WAL generation and available disk space.
9.27.5. Snapshot Synchronization Functions
Postgres Pro allows database sessions to synchronize their snapshots. A snapshot determines which data is visible to the transaction that is using the snapshot. Synchronized snapshots are necessary when two or more sessions need to see identical content in the database. If two sessions just start their transactions independently, there is always a possibility that some third transaction commits between the executions of the two START TRANSACTION commands, so that one session sees the effects of that transaction and the other does not.
To solve this problem, Postgres Pro allows a transaction to export the snapshot it is using. As long as the exporting transaction remains open, other transactions can import its snapshot, and thereby be guaranteed that they see exactly the same view of the database that the first transaction sees. But note that any database changes made by any one of these transactions remain invisible to the other transactions, as is usual for changes made by uncommitted transactions. So the transactions are synchronized with respect to pre-existing data, but act normally for changes they make themselves.
Snapshots are exported with the pg_export_snapshot function, shown in Table 9.88, and imported with the SET TRANSACTION command.
Table 9.88. Snapshot Synchronization Functions
Function Description |
|---|
Saves the transaction's current snapshot and returns a A transaction can export more than one snapshot, if needed. Note that doing so is only useful in |
9.27.6. Replication Management Functions
The functions shown in Table 9.89 are for controlling and interacting with replication features. See Section 26.2.5, Section 26.2.6, and Chapter 52 for information about the underlying features. Use of functions for replication origin is restricted to superusers. Use of functions for replication slots is restricted to superusers and users having REPLICATION privilege.
Many of these functions have equivalent commands in the replication protocol; see Section 55.4.
The functions described in Section 9.27.3, Section 9.27.4, and Section 9.27.5 are also relevant for replication.
Table 9.89. Replication Management Functions
Function Description |
|---|
Creates a new physical replication slot named |
Drops the physical or logical replication slot named |
Creates a new logical (decoding) replication slot named |
Copies an existing physical replication slot named |
Copies an existing logical replication slot named |
Returns changes in the slot |
Behaves just like the |
Behaves just like the |
Behaves just like the |
Advances the current confirmed position of a replication slot named |
Creates a replication origin with the given external name, and returns the internal ID assigned to it. |
Deletes a previously-created replication origin, including any associated replay progress. |
Looks up a replication origin by name and returns the internal ID. If no such replication origin is found, |
Marks the current session as replaying from the given origin, allowing replay progress to be tracked. Can only be used if no origin is currently selected. Use |
Cancels the effects of |
Returns true if a replication origin has been selected in the current session. |
Returns the replay location for the replication origin selected in the current session. The parameter |
Marks the current transaction as replaying a transaction that has committed at the given LSN and timestamp. Can only be called when a replication origin has been selected using |
Cancels the effects of |
Sets replication progress for the given node to the given location. This is primarily useful for setting up the initial location, or setting a new location after configuration changes and similar. Be aware that careless use of this function can lead to inconsistently replicated data. |
Returns the replay location for the given replication origin. The parameter |
Emits a logical decoding message. This can be used to pass generic messages to logical decoding plugins through WAL. The |
9.27.7. Database Object Management Functions
The functions shown in Table 9.90 calculate the disk space usage of database objects, or assist in presentation of usage results. All these functions return sizes measured in bytes. If an OID that does not represent an existing object is passed to one of these functions, NULL is returned.
Table 9.90. Database Object Size Functions
Function Description |
|---|
Shows the number of bytes used to store any individual data value. If applied directly to a table column value, this reflects any compression that was done. |
Computes the total disk space used by the database with the specified name or OID. To use this function, you must have |
Computes the total disk space used by indexes attached to the specified table. |
Computes the disk space used by one “fork” of the specified relation. (Note that for most purposes it is more convenient to use the higher-level functions
|
Accepts the OID or name of a temporary table and returns the total size in bytes of |
Converts a size in human-readable format (as returned by |
Converts a size in bytes into a more easily human-readable format with size units (bytes, kB, MB, GB or TB as appropriate). Note that the units are powers of 2 rather than powers of 10, so 1kB is 1024 bytes, 1MB is 10242 = 1048576 bytes, and so on. |
Computes the disk space used by the specified table, excluding indexes (but including its TOAST table if any, free space map, and visibility map). |
Computes the total disk space used in the tablespace with the specified name or OID. To use this function, you must have |
Computes the total disk space used by the specified table, including all indexes and TOAST data. The result is equivalent to |
The functions above that operate on tables or indexes accept a regclass argument, which is simply the OID of the table or index in the pg_class system catalog. You do not have to look up the OID by hand, however, since the regclass data type's input converter will do the work for you. Just write the table name enclosed in single quotes so that it looks like a literal constant. For compatibility with the handling of ordinary SQL names, the string will be converted to lower case unless it contains double quotes around the table name.
The functions shown in Table 9.91 assist in identifying the specific disk files associated with database objects.
Table 9.91. Database Object Location Functions
Function Description |
|---|
Returns the “filenode” number currently assigned to the specified relation. The filenode is the base component of the file name(s) used for the relation (see Section 70.1 for more information). For most relations the result is the same as |
Returns the entire file path name (relative to the database cluster's data directory, |
Returns a relation's OID given the tablespace OID and filenode it is stored under. This is essentially the inverse mapping of |
Table 9.92 lists functions used to manage collations.
Table 9.92. Collation Management Functions
Function Description |
|---|
Returns the actual version of the collation object as it is currently installed in the operating system. If this is different from the value in |
Adds collations to the system catalog |
Table 9.93 lists functions that provide information about the structure of partitioned tables.
Table 9.93. Partitioning Information Functions
For example, to check the total size of the data contained in a partitioned table measurement, one could use the following query:
SELECT pg_size_pretty(sum(pg_relation_size(relid))) AS total_size
FROM pg_partition_tree('measurement');
9.27.8. Index Maintenance Functions
Table 9.94 shows the functions available for index maintenance tasks. (Note that these maintenance tasks are normally done automatically by autovacuum; use of these functions is only required in special cases.) These functions cannot be executed during recovery. Use of these functions is restricted to superusers and the owner of the given index.
Table 9.94. Index Maintenance Functions
Function Description |
|---|
Scans the specified BRIN index to find page ranges in the base table that are not currently summarized by the index; for any such range it creates a new summary index tuple by scanning those table pages. Returns the number of new page range summaries that were inserted into the index. |
Summarizes the page range covering the given block, if not already summarized. This is like |
Removes the BRIN index tuple that summarizes the page range covering the given table block, if there is one. |
Cleans up the “pending” list of the specified GIN index by moving entries in it, in bulk, to the main GIN data structure. Returns the number of pages removed from the pending list. If the argument is a GIN index built with the |
9.27.9. Generic File Access Functions
The functions shown in Table 9.95 provide native access to files on the machine hosting the server. Only files within the database cluster directory and the log_directory can be accessed, unless the user is a superuser or is granted the role pg_read_server_files. Use a relative path for files in the cluster directory, and a path matching the log_directory configuration setting for log files.
Note that granting users the EXECUTE privilege on pg_read_file(), or related functions, allows them the ability to read any file on the server that the database server process can read; these functions bypass all in-database privilege checks. This means that, for example, a user with such access is able to read the contents of the pg_authid table where authentication information is stored, as well as read any table data in the database. Therefore, granting access to these functions should be carefully considered.
Some of these functions take an optional missing_ok parameter, which specifies the behavior when the file or directory does not exist. If true, the function returns NULL or an empty result set, as appropriate. If false, an error is raised. The default is false.
Table 9.95. Generic File Access Functions
9.27.10. Advisory Lock Functions
The functions shown in Table 9.96 manage advisory locks. For details about proper use of these functions, see Section 13.3.5.
All these functions are intended to be used to lock application-defined resources, which can be identified either by a single 64-bit key value or two 32-bit key values (note that these two key spaces do not overlap). If another session already holds a conflicting lock on the same resource identifier, the functions will either wait until the resource becomes available, or return a false result, as appropriate for the function. Locks can be either shared or exclusive: a shared lock does not conflict with other shared locks on the same resource, only with exclusive locks. Locks can be taken at session level (so that they are held until released or the session ends) or at transaction level (so that they are held until the current transaction ends; there is no provision for manual release). Multiple session-level lock requests stack, so that if the same resource identifier is locked three times there must then be three unlock requests to release the resource in advance of session end.
Table 9.96. Advisory Lock Functions
9.27.11. Compression Control Functions
The functions shown in Table 9.97 provide information about CFS state and activity and control CFS garbage collection.
Table 9.97. Compression Control Functions
| Name | Return Type | Description |
|---|---|---|
| integer | Starts garbage collection using the specified number of workers. You can only run this function to start the garbage collection manually if background garbage collection is disabled. |
| boolean | Enables/disables background garbage collection. Alternatively, you can use the cfs_gc configuration variable. |
| integer | Performs garbage collection for a particular table. This function returns the number of processed segments. |
| text | Displays the CFS version and the specific compression algorithm used. |
| float8 | Estimates the effect of table compression. Returns the average compression ratio for the first ten percent of relation blocks (but no more than 100 blocks). |
| float8 | Returns the actual compression ratio for all segments of the compressed relation. |
| float8 | Returns the average fragmentation ratio of the relation files. |
| int64 | Returns the total size of pages processed by CFS during garbage collection. |
| int64 | Returns the number of pages processed by CFS during garbage collection. |
| int64 | Returns the number of files compacted by CFS during garbage collection. |
| int64 | Returns the number of files scanned by CFS during garbage collection. |
9.27.12. Operation Log Support Functions
An operation log stores information about system events of critical importance, such as an upgrade, execution of pg_resetwal and so on. This information is not interesting to regular users, but is highly useful for vendor's technical support. Recording to the operation log is only done at the system level (without any actions on the part of the user), and SQL functions are used to read the operation log. The function shown in Table 9.98 reads the operation log.
Table 9.98. Operation Log Support Functions
Function Description |
|---|
Where:
This system function is created automatically for new databases and needs to be created for existing databases, as follows:
CREATE OR REPLACE FUNCTION
pg_operation_log(
OUT event text,
OUT edition text,
OUT version text,
OUT lsn pg_lsn,
OUT last timestamptz,
OUT count int4)
RETURNS SETOF record
LANGUAGE INTERNAL
STABLE STRICT PARALLEL SAFE
AS 'pg_operation_log';
|
This is an example of what the pg_operation_log function returns:
select * from pg_operation_log(); event | edition | version | lsn | last | count ------------+---------+---------+-----------+------------------------+------- startup | vanilla | 10.22.0 | 0/8000028 | 2022-10-27 23:06:27+03 | 1 pg_upgrade | 1c | 15.0.0 | 0/8000028 | 2022-10-27 23:06:27+03 | 1 startup | 1c | 15.0.0 | 0/80001F8 | 2022-10-27 23:06:53+03 | 2 (3 rows)
Note
If an operation log is empty, before a record for pg_upgrade, a record is added for startup with the previous version having the following specifics: as there is no information in pg_upgrade on the patch version number of the previous version for each edition (1c, std, ent), the patch version number (third number in the version number) is set to zero. For an upgrade from 1c or vanilla, it cannot be distinguished whether the edition of the database before upgrade is vanilla or 1c, and vanilla edition is used for the startup record.
9.27.13. Debugging Functions
The function shown in Table 9.99 can assist you in low-level activities, such as debugging or exploring corrupted Postgres Pro databases.
Table 9.99. Snapshot Synchronization Functions
| Name | Return Type | Description |
|---|---|---|
| void | Sets the current transaction to ignore MVCC rules and see all versions of data. |
Use pg_snapshot_any with care. Run it in a transaction with isolation level REPEATABLE READ or higher, otherwise the specific snapshot will be replaced by a new one by the next query. Only superusers can run this function.
Note
If you created the database cluster using the server version that did not provide this function, execute the command:
CREATE FUNCTION pg_snapshot_any() RETURNS void AS 'pg_snapshot_any' LANGUAGE internal;
