Компания Postgres Professional

9.28. Функции для системного администрирования
Пред.	Наверх	Глава 9. Функции и операторы	Начало	След.

9.28. Функции для системного администрирования #

9.28.1. Функции для управления конфигурацией
9.28.2. Функции для передачи сигналов серверу
9.28.3. Функции управления резервным копированием
9.28.4. Функции управления восстановлением
9.28.5. Функции синхронизации снимков
9.28.6. Функции управления репликацией
9.28.7. Функции управления объектами баз данных
9.28.8. Функции обслуживания индексов
9.28.9. Функции для работы с обычными файлами
9.28.10. Функции управления рекомендательными блокировками
9.28.11. Опорные функции журнала операций
9.28.12. Отладочные функции
9.28.13. Функции для устранения неполадок

Функции, описанные в этом разделе, предназначены для контроля и управления сервером Postgres Pro.

9.28.1. Функции для управления конфигурацией #

В Таблице 9.95 показаны функции, позволяющие получить и изменить значения параметров конфигурации выполнения.

Таблица 9.95. Функции для управления конфигурацией

Функция Описание Пример(ы)
`current_setting` ( `setting_name` `text` [, `missing_ok` `boolean`] ) → `text` Выдаёт текущее значение параметра `setting_name`. Если такого параметра нет, `current_setting` выдаёт ошибку, если только дополнительно не передан параметр `missing_ok` со значением `true` (в этом случае выдаётся NULL). Эта функция соответствует SQL-команде SHOW. `current_setting('datestyle')` → `ISO, MDY`
`set_config` ( `setting_name` `text`, `new_value` `text`, `is_local` `boolean` ) → `text` Устанавливает для параметра `setting_name` значение `new_value` и возвращает это значение. Если параметр `is_local` равен `true`, новое значение будет действовать только в рамках текущей транзакции. Чтобы это значение действовало на протяжении текущего сеанса, присвойте этому параметру `false`. Эта функция соответствует SQL-команде SET. Функция `set_config` принимает значение NULL для `new_value`, однако, так как у параметров не может быть значение NULL, оно воспринимается как запрос на сброс параметра до значения по умолчанию. `set_config('log_statement_stats', 'off', false)` → `off`

Функция

Описание

Пример(ы)

current_setting ( setting_name text [, missing_ok boolean] ) → text

Выдаёт текущее значение параметра setting_name. Если такого параметра нет, current_setting выдаёт ошибку, если только дополнительно не передан параметр missing_ok со значением true (в этом случае выдаётся NULL). Эта функция соответствует SQL-команде SHOW.

current_setting('datestyle') → ISO, MDY

set_config ( setting_name text, new_value text, is_local boolean ) → text

Устанавливает для параметра setting_name значение new_value и возвращает это значение. Если параметр is_local равен true, новое значение будет действовать только в рамках текущей транзакции. Чтобы это значение действовало на протяжении текущего сеанса, присвойте этому параметру false. Эта функция соответствует SQL-команде SET.

Функция set_config принимает значение NULL для new_value, однако, так как у параметров не может быть значение NULL, оно воспринимается как запрос на сброс параметра до значения по умолчанию.

set_config('log_statement_stats', 'off', false) → off

9.28.2. Функции для передачи сигналов серверу #

Функции, перечисленные в Таблице 9.96, позволяют передавать управляющие сигналы другим серверным процессам. Вызывать эти функции по умолчанию разрешено только суперпользователям, но доступ к ним можно дать и другим пользователям командой GRANT, кроме явно отмеченных исключений.

Все эти функции возвращают true, если сигнал успешно отправлен, и false, если отправить сигнал не удалось.

Таблица 9.96. Функции для передачи сигналов серверу

Функция Описание
`pg_cancel_backend` ( `pid` `integer` ) → `boolean` Отменяет текущий запрос в сеансе, который обслуживается процессом с заданным PID. Это действие разрешается и ролям, являющимся членами роли, запрос которой отменяется, и ролям с правами роли `pg_signal_backend`; однако только суперпользователям разрешено отменять запросы других суперпользователей. В качестве исключения ролям с правами `pg_signal_autovacuum_worker` разрешено отменять рабочие процессы автоочистки, которые в других случаях считаются обслуживающими процессами суперпользователей.
`pg_log_backend_memory_contexts` ( `pid` `integer` ) → `boolean` Запрашивает вывод в журнал информации о контекстах памяти обслуживающего процесса с указанным PID. Эта функция может отправлять запрос обслуживающим и вспомогательным процессам, кроме процесса протоколирования. Запрошенная информация будет выведена в сообщениях уровня `LOG`, которые появятся в журнале сервера в зависимости от заданной конфигурации журнала (за дополнительными сведениями обратитесь к Разделу 18.8), но не будут передаваться клиенту независимо от client_min_messages.
`pg_reload_conf` () → `boolean` Даёт всем процессам сервера Postgres Pro команду перезагрузить файлы конфигурации. (Для этого посылается сигнал SIGHUP главному процессу, который, в свой очередь, посылает SIGHUP всем своим дочерним процессам.) Вы можете прочитать представления `pg_file_settings`, `pg_hba_file_rules` и `pg_ident_file_mappings`, чтобы проверить файлы конфигурации на предмет возможных ошибок перед перезагрузкой.
`pg_rotate_logfile` () → `boolean` Указывает менеджеру журнала сообщений немедленно переключиться на новый файл. Это имеет смысл, только когда работает встроенный сборщик сообщений, так как без него подпроцесс менеджера журнала не запускается.
`pg_terminate_backend` ( `pid` `integer`, `timeout` `bigint` `DEFAULT` `0` ) → `boolean` Завершает сеанс, который обслуживается процессом с заданным PID. Это действие разрешается и ролям, являющимся членами роли, обслуживающий процесс которой завершается, и ролям с правами роли `pg_signal_backend`; однако прерывать обслуживающие процессы других суперпользователей разрешено только суперпользователям. В качестве исключения ролям с правами `pg_signal_autovacuum_worker` разрешено завершать рабочие процессы автоочистки, которые в других случаях считаются обслуживающими процессами суперпользователей. Если параметр `timeout` не задан или равен нулю, данная функция возвращает `true` независимо от того, действительно ли завершается процесс; то есть результат показывает только, что сигнал был отправлен успешно. Если параметр `timeout` задан (в миллисекундах) и больше нуля, функция ожидает, пока процесс не будет фактически завершён или пока не пройдёт заданное время. Если процесс завершён, функция возвращает `true`. В случае тайм-аута выдаётся предупреждение и возвращается `false`.

Функция

Описание

pg_cancel_backend ( pid integer ) → boolean

Отменяет текущий запрос в сеансе, который обслуживается процессом с заданным PID. Это действие разрешается и ролям, являющимся членами роли, запрос которой отменяется, и ролям с правами роли pg_signal_backend; однако только суперпользователям разрешено отменять запросы других суперпользователей. В качестве исключения ролям с правами pg_signal_autovacuum_worker разрешено отменять рабочие процессы автоочистки, которые в других случаях считаются обслуживающими процессами суперпользователей.

pg_log_backend_memory_contexts ( pid integer ) → boolean

Запрашивает вывод в журнал информации о контекстах памяти обслуживающего процесса с указанным PID. Эта функция может отправлять запрос обслуживающим и вспомогательным процессам, кроме процесса протоколирования. Запрошенная информация будет выведена в сообщениях уровня LOG, которые появятся в журнале сервера в зависимости от заданной конфигурации журнала (за дополнительными сведениями обратитесь к Разделу 18.8), но не будут передаваться клиенту независимо от client_min_messages.

pg_reload_conf () → boolean

Даёт всем процессам сервера Postgres Pro команду перезагрузить файлы конфигурации. (Для этого посылается сигнал SIGHUP главному процессу, который, в свой очередь, посылает SIGHUP всем своим дочерним процессам.) Вы можете прочитать представления pg_file_settings, pg_hba_file_rules и pg_ident_file_mappings, чтобы проверить файлы конфигурации на предмет возможных ошибок перед перезагрузкой.

pg_rotate_logfile () → boolean

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

pg_terminate_backend ( pid integer, timeout bigint DEFAULT 0 ) → boolean

Завершает сеанс, который обслуживается процессом с заданным PID. Это действие разрешается и ролям, являющимся членами роли, обслуживающий процесс которой завершается, и ролям с правами роли pg_signal_backend; однако прерывать обслуживающие процессы других суперпользователей разрешено только суперпользователям. В качестве исключения ролям с правами pg_signal_autovacuum_worker разрешено завершать рабочие процессы автоочистки, которые в других случаях считаются обслуживающими процессами суперпользователей.

Если параметр timeout не задан или равен нулю, данная функция возвращает true независимо от того, действительно ли завершается процесс; то есть результат показывает только, что сигнал был отправлен успешно. Если параметр timeout задан (в миллисекундах) и больше нуля, функция ожидает, пока процесс не будет фактически завершён или пока не пройдёт заданное время. Если процесс завершён, функция возвращает true. В случае тайм-аута выдаётся предупреждение и возвращается false.

pg_cancel_backend и pg_terminate_backend передают сигналы (SIGINT и SIGTERM, соответственно) серверному процессу с заданным кодом PID. Код активного процесса можно получить из столбца pid представления pg_stat_activity или просмотрев на сервере процессы с именем postgres (используя ps в Unix или Диспетчер задач в Windows). Роль пользователя активного процесса можно узнать в столбце usename представления pg_stat_activity.

pg_log_backend_memory_contexts может использоваться для получения в журнале сервера информации о контекстах памяти. Например:

postgres=# SELECT pg_log_backend_memory_contexts(pg_backend_pid());
 pg_log_backend_memory_contexts
--------------------------------
 t
(1 row)

Для каждого контекста памяти будет выводиться одно сообщение. Например:

LOG:  logging memory contexts of PID 10377
STATEMENT:  SELECT pg_log_backend_memory_contexts(pg_backend_pid());
LOG:  level: 1; TopMemoryContext: 80800 total in 6 blocks; 14432 free (5 chunks); 66368 used
LOG:  level: 2; pgstat TabStatusArray lookup hash table: 8192 total in 1 blocks; 1408 free (0 chunks); 6784 used
LOG:  level: 2; TopTransactionContext: 8192 total in 1 blocks; 7720 free (1 chunks); 472 used
LOG:  level: 2; RowDescriptionContext: 8192 total in 1 blocks; 6880 free (0 chunks); 1312 used
LOG:  level: 2; MessageContext: 16384 total in 2 blocks; 5152 free (0 chunks); 11232 used
LOG:  level: 2; Operator class cache: 8192 total in 1 blocks; 512 free (0 chunks); 7680 used
LOG:  level: 2; smgr relation table: 16384 total in 2 blocks; 4544 free (3 chunks); 11840 used
LOG:  level: 2; TransactionAbortContext: 32768 total in 1 blocks; 32504 free (0 chunks); 264 used
...
LOG:  level: 2; ErrorContext: 8192 total in 1 blocks; 7928 free (3 chunks); 264 used
LOG:  Grand total: 1651920 bytes in 201 blocks; 622360 free (88 chunks); 1029560 used

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

9.28.3. Функции управления резервным копированием #

Функции, перечисленные в Таблице 9.97, предназначены для выполнения резервного копирования «на ходу». Эти функции нельзя выполнять во время восстановления (за исключением pg_backup_start, pg_backup_stop и pg_wal_lsn_diff).

Подробнее практическое применение этих функций описывается в Разделе 24.3.

Таблица 9.97. Функции управления резервным копированием

Функция Описание
`pg_create_restore_point` ( `name` `text` ) → `pg_lsn` Создаёт в журнале предзаписи именованный маркер, который можно использовать как цель при восстановлении, и возвращает соответствующую ему позицию в журнале. Полученное имя затем можно указать в параметре recovery_target_name, определив тем самым точку, до которой будет выполняться восстановление. Учтите, что если будет создано несколько точек восстановления с одним именем, восстановление остановится на первой точке с этим именем. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_current_wal_flush_lsn` () → `pg_lsn` Выдаёт текущую позицию сброса данных в журнале предзаписи (см. примечания ниже).
`pg_current_wal_insert_lsn` () → `pg_lsn` Выдаёт текущую позицию добавления в журнале предзаписи (см. примечания ниже).
`pg_current_wal_lsn` () → `pg_lsn` Выдаёт текущую позицию записи в журнале предзаписи (см. примечания ниже).
`pg_backup_start` ( `label` `text` [, `fast` `boolean`] ) → `pg_lsn` Подготавливает сервер к резервному копированию «на лету». Единственный обязательный параметр задаёт произвольную пользовательскую метку резервной копии. (Обычно это имя, которое получит файл резервной копии.) Если необязательный второй параметр задан и имеет значение `true`, функция `pg_backup_start` должна выполниться максимально быстро. Это означает, что принудительно будет выполнена контрольная точка, вследствие чего кратковременно увеличится нагрузка на ввод-вывод и параллельно выполняемые запросы могут замедлиться. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_backup_stop` ( [`wait_for_archive` `boolean`] ) → `record` ( `lsn` `pg_lsn`, `labelfile` `text`, `spcmapfile` `text` ) Завершает выполнение резервного копирования. В результате возвращается ожидаемое содержимое файла метки резервной копии и файла карты табличных пространств, которое нужно сохранить в файлы в архиве (не в каталоге данных). Эти файлы нельзя записывать в каталог работающей базы данных (в противном случае Postgres Pro не сможет перезапуститься, если произойдёт сбой). У этой функции есть также необязательный параметр типа `boolean`. Если он равен false, `pg_backup_stop` завершится сразу после окончания резервного копирования, не дожидаясь архивации WAL. Это поведение полезно только для программ резервного копирования, которые осуществляют архивацию WAL независимо. Если же WAL не будет заархивирован вовсе, резервная копия может оказаться неполной, и, как следствие, непригодной для восстановления. Когда он равен true (по умолчанию), `pg_backup_stop` будет ждать выполнения архивации WAL, если архивирование включено. Для резервного сервера это означает, что ожидание возможно только при условии `archive_mode = always`. Если активность записи на ведущем сервере невысока, может иметь смысл выполнить на нём `pg_switch_wal` для немедленного переключения сегмента. При выполнении на ведущем эта функция также создаёт файл истории резервного копирования в области архива журнала предзаписи. В этом файле для данной резервной копии сохраняется метка, заданная при вызове `pg_backup_start`, начальная и конечная позиция в журнале предзаписи, а также время начала и окончания копирования. После записи конечной позиции текущая позиция автоматически перемещается к следующему файлу журнала предзаписи, чтобы файл конечной позиции можно было немедленно архивировать для завершения резервного копирования. В результате эта функция выдаёт единственную запись. Столбец `lsn` в ней содержит позицию завершения копирования в журнале предзаписи (её также можно игнорировать). Во втором столбце передаётся содержимое файла метки резервной копии, а в третьем — содержимое файла карты табличных пространств. Эту информацию нужно сохранить в составе резервной копии, она потребуется в процессе восстановления. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_switch_wal` () → `pg_lsn` Производит принудительное переключение журнала предзаписи на новый файл, что позволяет архивировать текущий (в предположении, что выполняется непрерывная архивация). Результат функции — конечная позиция в только что законченном файле журнала предзаписи + 1. Если с момента последнего переключения файлов не было активности, отражающейся в журнале предзаписи, `pg_switch_wal` не делает ничего и возвращает начальную позицию в файле журнала предзаписи, используемом в данный момент. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_walfile_name` ( `lsn` `pg_lsn` ) → `text` Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла WAL.
`pg_walfile_name_offset` ( `lsn` `pg_lsn` ) → `record` ( `file_name` `text`, `file_offset` `integer` ) Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла и байтовое смещение в нём.
`pg_split_walfile_name` ( `file_name` `text` ) → `record` ( `segment_number` `numeric`, `timeline_id` `bigint` ) Извлекает последовательный номер и идентификатор линии времени из имени файла WAL.
`pg_wal_lsn_diff` ( `lsn1` `pg_lsn`, `lsn2` `pg_lsn` ) → `numeric` Вычисляет разницу в байтах (`lsn1` - `lsn2`) между двумя позициями в журнале предзаписи. Полученный результат можно использовать с `pg_stat_replication` или с некоторыми функциями, перечисленными в Таблица 9.97, для определения задержки репликации.

Функция

Описание

pg_create_restore_point ( name text ) → pg_lsn

Создаёт в журнале предзаписи именованный маркер, который можно использовать как цель при восстановлении, и возвращает соответствующую ему позицию в журнале. Полученное имя затем можно указать в параметре recovery_target_name, определив тем самым точку, до которой будет выполняться восстановление. Учтите, что если будет создано несколько точек восстановления с одним именем, восстановление остановится на первой точке с этим именем.

По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.

pg_current_wal_flush_lsn () → pg_lsn

Выдаёт текущую позицию сброса данных в журнале предзаписи (см. примечания ниже).

pg_current_wal_insert_lsn () → pg_lsn

Выдаёт текущую позицию добавления в журнале предзаписи (см. примечания ниже).

pg_current_wal_lsn () → pg_lsn

Выдаёт текущую позицию записи в журнале предзаписи (см. примечания ниже).

pg_backup_start ( label text [, fast boolean] ) → pg_lsn

Подготавливает сервер к резервному копированию «на лету». Единственный обязательный параметр задаёт произвольную пользовательскую метку резервной копии. (Обычно это имя, которое получит файл резервной копии.) Если необязательный второй параметр задан и имеет значение true, функция pg_backup_start должна выполниться максимально быстро. Это означает, что принудительно будет выполнена контрольная точка, вследствие чего кратковременно увеличится нагрузка на ввод-вывод и параллельно выполняемые запросы могут замедлиться.

pg_backup_stop ( [wait_for_archive boolean] ) → record ( lsn pg_lsn, labelfile text, spcmapfile text )

Завершает выполнение резервного копирования. В результате возвращается ожидаемое содержимое файла метки резервной копии и файла карты табличных пространств, которое нужно сохранить в файлы в архиве (не в каталоге данных). Эти файлы нельзя записывать в каталог работающей базы данных (в противном случае Postgres Pro не сможет перезапуститься, если произойдёт сбой).

У этой функции есть также необязательный параметр типа boolean. Если он равен false, pg_backup_stop завершится сразу после окончания резервного копирования, не дожидаясь архивации WAL. Это поведение полезно только для программ резервного копирования, которые осуществляют архивацию WAL независимо. Если же WAL не будет заархивирован вовсе, резервная копия может оказаться неполной, и, как следствие, непригодной для восстановления. Когда он равен true (по умолчанию), pg_backup_stop будет ждать выполнения архивации WAL, если архивирование включено. Для резервного сервера это означает, что ожидание возможно только при условии archive_mode = always. Если активность записи на ведущем сервере невысока, может иметь смысл выполнить на нём pg_switch_wal для немедленного переключения сегмента.

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

В результате эта функция выдаёт единственную запись. Столбец lsn в ней содержит позицию завершения копирования в журнале предзаписи (её также можно игнорировать). Во втором столбце передаётся содержимое файла метки резервной копии, а в третьем — содержимое файла карты табличных пространств. Эту информацию нужно сохранить в составе резервной копии, она потребуется в процессе восстановления.

pg_switch_wal () → pg_lsn

Производит принудительное переключение журнала предзаписи на новый файл, что позволяет архивировать текущий (в предположении, что выполняется непрерывная архивация). Результат функции — конечная позиция в только что законченном файле журнала предзаписи + 1. Если с момента последнего переключения файлов не было активности, отражающейся в журнале предзаписи, pg_switch_wal не делает ничего и возвращает начальную позицию в файле журнала предзаписи, используемом в данный момент.

pg_walfile_name ( lsn pg_lsn ) → text

Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла WAL.

pg_walfile_name_offset ( lsn pg_lsn ) → record ( file_name text, file_offset integer )

Выдаёт для заданной позиции в журнале предзаписи имя соответствующего файла и байтовое смещение в нём.

pg_split_walfile_name ( file_name text ) → record ( segment_number numeric, timeline_id bigint )

Извлекает последовательный номер и идентификатор линии времени из имени файла WAL.

pg_wal_lsn_diff ( lsn1 pg_lsn, lsn2 pg_lsn ) → numeric

Вычисляет разницу в байтах (lsn1 - lsn2) между двумя позициями в журнале предзаписи. Полученный результат можно использовать с pg_stat_replication или с некоторыми функциями, перечисленными в Таблица 9.97, для определения задержки репликации.

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_backup_stop()).lsn);
        file_name         | file_offset
--------------------------+-------------
 00000001000000000000000D |     4039624
(1 row)

Родственная ей функция pg_walfile_name извлекает только имя файла журнала предзаписи.

pg_split_walfile_name полезна для вычисления LSN на основе смещения файла и имени файла WAL, например:

postgres=# \set file_name '000000010000000100C000AB'
postgres=# \set offset 256
postgres=# SELECT '0/0'::pg_lsn + pd.segment_number * ps.setting::int + :offset AS lsn
  FROM pg_split_walfile_name(:'file_name') pd,
       pg_show_all_settings() ps
  WHERE ps.name = 'wal_segment_size';
      lsn
---------------
 C001/AB000100
(1 row)

9.28.4. Функции управления восстановлением #

Функции, показанные в Таблице 9.98, предоставляют сведения о текущем состоянии ведомого сервера. Эти функции могут выполняться как во время восстановления, так и в обычном режиме работы.

Таблица 9.98. Функции для получения информации о восстановлении

Функция Описание
`pg_is_in_recovery` () → `boolean` Возвращает true, если в данный момент выполняется процедура восстановления.
`pg_last_wal_receive_lsn` () → `pg_lsn` Выдаёт позицию последней записи в журнале предзаписи, которая была получена и записана на диск в процессе потоковой репликации. Пока выполняется потоковая репликация, эта позиция постоянно увеличивается. По окончании восстановления она остаётся на записи WAL, полученной и записанной на диск последней. Если потоковая репликация отключена или ещё не запускалась, функция возвращает `NULL`.
`pg_last_wal_replay_lsn` () → `pg_lsn` Выдаёт позицию последней записи в журнале предзаписи, которая была воспроизведёна при восстановлении. В процессе восстановления эта позиция постоянно увеличивается. По окончании этого процесса она остаётся на записи WAL, которая была восстановлена последней. Если сервер при запуске не выполнял процедуру восстановления, эта функция выдаёт `NULL`.
`pg_last_xact_replay_timestamp` () → `timestamp with time zone` Выдаёт отметку времени последней транзакции, воспроизведённой при восстановлении. Это время, когда на главном сервере произошла фиксация или откат записи WAL для этой транзакции. Если в процессе восстановления не была воспроизведена ни одна транзакция, эта функция выдаёт `NULL`. В противном случае возвращаемое значение постоянно увеличивается в процессе восстановления. По окончании восстановления в нём остаётся время транзакции, которая была восстановлена последней. Если сервер при запуске не выполнял процедуру восстановления, эта функция выдаёт `NULL`.
`pg_get_wal_resource_managers` () → `setof record` ( `rm_id` `integer`, `rm_name` `text`, `rm_builtin` `boolean` ) Выдаёт загруженные на данный момент менеджеры ресурсов WAL в системе. Столбец `rm_builtin` показывает, является ли данный менеджер ресурсов встроенным или пользовательским, то есть создаваемым расширением.

Функция

Описание

pg_is_in_recovery () → boolean

Возвращает true, если в данный момент выполняется процедура восстановления.

pg_last_wal_receive_lsn () → pg_lsn

Выдаёт позицию последней записи в журнале предзаписи, которая была получена и записана на диск в процессе потоковой репликации. Пока выполняется потоковая репликация, эта позиция постоянно увеличивается. По окончании восстановления она остаётся на записи WAL, полученной и записанной на диск последней. Если потоковая репликация отключена или ещё не запускалась, функция возвращает NULL.

pg_last_wal_replay_lsn () → pg_lsn

Выдаёт позицию последней записи в журнале предзаписи, которая была воспроизведёна при восстановлении. В процессе восстановления эта позиция постоянно увеличивается. По окончании этого процесса она остаётся на записи WAL, которая была восстановлена последней. Если сервер при запуске не выполнял процедуру восстановления, эта функция выдаёт NULL.

pg_last_xact_replay_timestamp () → timestamp with time zone

Выдаёт отметку времени последней транзакции, воспроизведённой при восстановлении. Это время, когда на главном сервере произошла фиксация или откат записи WAL для этой транзакции. Если в процессе восстановления не была воспроизведена ни одна транзакция, эта функция выдаёт NULL. В противном случае возвращаемое значение постоянно увеличивается в процессе восстановления. По окончании восстановления в нём остаётся время транзакции, которая была восстановлена последней. Если сервер при запуске не выполнял процедуру восстановления, эта функция выдаёт NULL.

pg_get_wal_resource_managers () → setof record ( rm_id integer, rm_name text, rm_builtin boolean )

Выдаёт загруженные на данный момент менеджеры ресурсов WAL в системе. Столбец rm_builtin показывает, является ли данный менеджер ресурсов встроенным или пользовательским, то есть создаваемым расширением.

Функции, перечисленные в Таблице 9.99 управляют процессом восстановления. Вызывать их в другое время нельзя.

Таблица 9.99. Функции управления восстановлением

Функция Описание
`pg_is_wal_replay_paused` () → `boolean` Возвращает true, если запрошена приостановка восстановления.
`pg_get_wal_replay_pause_state` () → `text` Возвращает состояние приостановки восстановления. Возвращаемые значения: `not paused` — приостановка не запрашивалась, `pause requested` — получен запрос на приостановку, но восстановление ещё не приостановлено, и `paused`, если восстановление действительно приостановлено.
`pg_promote` ( `wait` `boolean` `DEFAULT` `true`, `wait_seconds` `integer` `DEFAULT` `60` ) → `boolean` Повышает статус ведомого сервера до ведущего. Если параметр `wait` равен `true` (по умолчанию), эта функция дожидается завершения операции повышения в течение `wait_seconds` секунд и возвращает `true` в случае успешного повышения или `false` в противном случае. Если параметр `wait` равен `false`, функция возвращает `true` сразу после передачи процессу postmaster сигнала `SIGUSR1`, инициирующего повышение. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_wal_replay_pause` () → `void` Запрашивает приостановку восстановления. Запрос приостановки может быть выполнен не сразу. Если вы хотите убедиться, что восстановление действительно приостановлено, проверьте состояние приостановки восстановления с помощью функции `pg_get_wal_replay_pause_state()`. Заметьте, что `pg_get_wal_replay_paused` показывает только был ли сделан запрос. Когда восстановление приостановлено, запись изменений в базу не производится. В режиме «горячего резерва» все последующие запросы будут видеть один согласованный снимок базы данных, что исключает конфликты запросов до продолжения восстановления. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.
`pg_wal_replay_resume` () → `void` Возобновляет восстановление, если оно было приостановлено. По умолчанию доступ к этой функции имеют только суперпользователи, но право на её выполнение (EXECUTE) можно дать и другим пользователям.

Функция

Описание

pg_is_wal_replay_paused () → boolean

Возвращает true, если запрошена приостановка восстановления.

pg_get_wal_replay_pause_state () → text

Возвращает состояние приостановки восстановления. Возвращаемые значения: not paused — приостановка не запрашивалась, pause requested — получен запрос на приостановку, но восстановление ещё не приостановлено, и paused, если восстановление действительно приостановлено.

pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean

Повышает статус ведомого сервера до ведущего. Если параметр wait равен true (по умолчанию), эта функция дожидается завершения операции повышения в течение wait_seconds секунд и возвращает true в случае успешного повышения или false в противном случае. Если параметр wait равен false, функция возвращает true сразу после передачи процессу postmaster сигнала SIGUSR1, инициирующего повышение.

pg_wal_replay_pause () → void

Запрашивает приостановку восстановления. Запрос приостановки может быть выполнен не сразу. Если вы хотите убедиться, что восстановление действительно приостановлено, проверьте состояние приостановки восстановления с помощью функции pg_get_wal_replay_pause_state(). Заметьте, что pg_get_wal_replay_paused показывает только был ли сделан запрос. Когда восстановление приостановлено, запись изменений в базу не производится. В режиме «горячего резерва» все последующие запросы будут видеть один согласованный снимок базы данных, что исключает конфликты запросов до продолжения восстановления.

pg_wal_replay_resume () → void

Возобновляет восстановление, если оно было приостановлено.

Функции pg_wal_replay_pause и pg_wal_replay_resume нельзя выполнять в процессе повышения. Если повышение запрашивается, когда восстановление приостановлено, сервер выходит из состояния паузы и продолжает процедуру повышения.

Когда потоковая репликация отключена, пауза при восстановлении может длиться сколь угодно долго без каких-либо проблем. Если же потоковая репликация осуществляется, новые записи WAL продолжат поступать и заполнят весь диск рано или поздно, в зависимости от длительности паузы, интенсивности записи в WAL и объёма свободного пространства.

9.28.5. Функции синхронизации снимков #

Postgres Pro позволяет синхронизировать снимки состояния между сеансами баз данных. Снимок состояния определяет, какие данные видны транзакции, работающей с этим снимком. Синхронизация снимков необходима, когда в двух или более сеансах нужно видеть одно и то же содержимое базы данных. Если в двух сеансах транзакции запускаются независимо, всегда есть вероятность, что некая третья транзакция будет зафиксирована между командами START TRANSACTION для первых двух, и в результате в одном сеансе будет виден результат третьей, а в другом — нет.

Для решения этой проблемы Postgres Pro позволяет транзакции экспортировать снимок состояния, с которым она работает. Пока экспортирующая этот снимок транзакция выполняется, другие транзакции могут импортировать его и, таким образом, увидеть абсолютно то же состояние базы данных, что видит первая транзакция. Но учтите, что любые изменения, произведённые этими транзакциями, будут не видны для других, как это и должно быть с изменениями в незафиксированных транзакциях. Таким образом, транзакции синхронизируют только начальное состояние данных, а последующие производимые в них изменения изолируются как обычно.

Снимки состояния экспортируются с помощью функции pg_export_snapshot, показанной в Таблице 9.100, и импортируются командой SET TRANSACTION.

Таблица 9.100. Функции синхронизации снимков

Функция Описание
`pg_export_snapshot` () → `text` Сохраняет текущий снимок состояния транзакции и возвращает строку типа `text` с идентификатором этого снимка. Эта строка должна передаваться внешними средствами клиентам, которые будут импортировать этот снимок. Снимок может быть импортирован только при условии, что экспортировавшая его транзакция ещё не завершена. Если необходимо, транзакция может экспортировать несколько снимков. Заметьте, что это имеет смысл только для транзакций уровня `READ COMMITTED`, так как транзакции уровня изоляции `REPEATABLE READ` и выше работают с одним снимком состояния на протяжении всего своего существования. После того как транзакция экспортировала снимок, её нельзя сделать подготовленной с помощью PREPARE TRANSACTION.
`pg_log_standby_snapshot` () → `pg_lsn` Сделать снимок выполняющихся транзакций и записать его в WAL, не дожидаясь, пока процессы bgwriter или checkpointer запишут его. Это полезно для логического декодирования на резервном сервере, поскольку создание логического слота должно откладываться до тех пор, пока такая запись не будет воспроизведена на резервном сервере.

Функция

Описание

pg_export_snapshot () → text

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

Если необходимо, транзакция может экспортировать несколько снимков. Заметьте, что это имеет смысл только для транзакций уровня READ COMMITTED, так как транзакции уровня изоляции REPEATABLE READ и выше работают с одним снимком состояния на протяжении всего своего существования. После того как транзакция экспортировала снимок, её нельзя сделать подготовленной с помощью PREPARE TRANSACTION.

pg_log_standby_snapshot () → pg_lsn

Сделать снимок выполняющихся транзакций и записать его в WAL, не дожидаясь, пока процессы bgwriter или checkpointer запишут его. Это полезно для логического декодирования на резервном сервере, поскольку создание логического слота должно откладываться до тех пор, пока такая запись не будет воспроизведена на резервном сервере.

9.28.6. Функции управления репликацией #

В Таблице 9.101 показаны функции, предназначенные для управления механизмом репликации и взаимодействия с ним. Чтобы изучить этот механизм подробнее, обратитесь к Подразделу 25.2.5, Подразделу 25.2.6 и Главе 49. По умолчанию только суперпользователи имеют разрешение выполнять функции с источниками репликации, но его можно дать и другим, воспользовавшись командой GRANT. Использование данных функций для слотов репликации разрешено только суперпользователям и пользователям, имеющим право REPLICATION.

Многие из этих функций соответствуют командам в протоколе репликации; см. Раздел 55.4.

Функции, описанные в Подразделе 9.28.3, Подразделе 9.28.4 и Подразделе 9.28.5, также имеют отношение к репликации.

Таблица 9.101. Функции управления репликацией

Функция Описание
`pg_create_physical_replication_slot` ( `slot_name` `name` [, `immediately_reserve` `boolean`, `temporary` `boolean`] ) → `record` ( `slot_name` `name`, `lsn` `pg_lsn` ) Создаёт новый физический слот репликации с именем `slot_name`. Необязательный второй параметр, когда он равен `true`, указывает, что LSN для этого слота репликации должен быть зарезервирован немедленно; в противном случае LSN резервируется при первом подключении клиента потоковой репликации. Передача изменений из физического слота возможна только по протоколу потоковой репликации — см. Раздел 55.4. Необязательный третий параметр, `temporary`, когда он равен true, указывает, что этот слот не должен постоянно храниться на диске, так как он предназначен только для текущего сеанса. Временные слоты также освобождаются при любой ошибке. Эта функция соответствует команде протокола репликации `CREATE_REPLICATION_SLOT ... PHYSICAL`.
`pg_drop_replication_slot` ( `slot_name` `name` ) → `void` Удаляет физический или логический слот репликации с именем `slot_name`. Соответствует команде протокола репликации `DROP_REPLICATION_SLOT`.
`pg_create_logical_replication_slot` ( `slot_name` `name`, `plugin` `name` [, `temporary` `boolean`, `twophase` `boolean`, `failover` `boolean`] ) → `record` ( `slot_name` `name`, `lsn` `pg_lsn` ) Создаёт новый логический (декодирующий) слот репликации с именем `slot_name`, используя модуль вывода `plugin`. Необязательный третий параметр, `temporary`, когда равен true, указывает, что этот слот не должен постоянно храниться на диске, так как предназначен только для текущего сеанса. Временные слоты также освобождаются при любой ошибке. Необязательный четвёртый параметр, `twophase`, когда равен true, указывает, что для данного слота включается декодирование подготовленных транзакций. Необязательный пятый параметр `failover`, когда равен true, указывает, что этот слот может быть синхронизирован с резервными серверами, чтобы логическая репликация могла быть возобновлена после отработки отказа. Вызов этой функции равнозначен выполнению команды протокола репликации `CREATE_REPLICATION_SLOT ... LOGICAL`.
`pg_copy_physical_replication_slot` ( `src_slot_name` `name`, `dst_slot_name` `name` [, `temporary` `boolean`] ) → `record` ( `slot_name` `name`, `lsn` `pg_lsn` ) Копирует существующий слот физической репликации с именем `src_slot_name` в слот с именем `dst_slot_name`. Скопированный слот физической репликации начинает резервировать WAL с того же последовательного номера LSN, что и исходный слот. Параметр `temporary` является необязательным и позволяет указать, будет ли слот временным. Если параметр `temporary` опущен, сохраняется то же свойство, что имеет исходный слот. Копирование аннулированного слота не допускается.
`pg_copy_logical_replication_slot` ( `src_slot_name` `name`, `dst_slot_name` `name` [, `temporary` `boolean` [, `plugin` `name`]] ) → `record` ( `slot_name` `name`, `lsn` `pg_lsn` ) Копирует существующий слот логической репликации с именем `src_slot_name` в слот с именем `dst_slot_name`, с возможностью смены модуля вывода и свойства временности. Скопированный логический слот начинает передачу с того же последовательного номера LSN, что и исходный слот. Параметры `temporary` и `plugin` являются необязательными; если они опущены, сохраняются свойства исходного слота. Параметр `failover` логического слота источника не копируется, и по умолчанию для него устанавливается значение `false`. Это позволяет устранить риск невозможности продолжить логическую репликацию после аварийного переключения на резервный сервер, с которым синхронизируется слот. Копирование аннулированного слота не допускается.
`pg_logical_slot_get_changes` ( `slot_name` `name`, `upto_lsn` `pg_lsn`, `upto_nchanges` `integer`, `VARIADIC` `options` `text[]` ) → `setof record` ( `lsn` `pg_lsn`, `xid` `xid`, `data` `text` ) Возвращает изменения в слоте `slot_name` с позиции, до которой ранее были получены изменения. Если параметры `upto_lsn` и `upto_nchanges` равны NULL, логическое декодирование продолжится до конца журнала транзакций. Если `upto_lsn` не NULL, декодироваться будут только транзакции, зафиксированные до заданного LSN. Если `upto_nchanges` не NULL, декодирование остановится, когда число строк, полученных при декодировании, превысит заданное значение. Заметьте однако, что фактическое число возвращённых строк может быть больше, так как это ограничение проверяется только после добавления строк, декодированных для очередной транзакции. Если указанный слот является слотом для отработки отказа логической репликации, то функция не выдаст результат, пока все физические слоты, указанные в `synchronized_standby_slots`, не подтвердят получение WAL.
`pg_logical_slot_peek_changes` ( `slot_name` `name`, `upto_lsn` `pg_lsn`, `upto_nchanges` `integer`, `VARIADIC` `options` `text[]` ) → `setof record` ( `lsn` `pg_lsn`, `xid` `xid`, `data` `text` ) Работает так же, как функция `pg_logical_slot_get_changes()`, но не забирает изменения; то есть, они будут получены снова при следующих вызовах.
`pg_logical_slot_get_binary_changes` ( `slot_name` `name`, `upto_lsn` `pg_lsn`, `upto_nchanges` `integer`, `VARIADIC` `options` `text[]` ) → `setof record` ( `lsn` `pg_lsn`, `xid` `xid`, `data` `bytea` ) Работает так же, как функция `pg_logical_slot_get_changes()`, но выдаёт изменения в типе `bytea`.
`pg_logical_slot_peek_binary_changes` ( `slot_name` `name`, `upto_lsn` `pg_lsn`, `upto_nchanges` `integer`, `VARIADIC` `options` `text[]` ) → `setof record` ( `lsn` `pg_lsn`, `xid` `xid`, `data` `bytea` ) Работает аналогично функции `pg_logical_slot_peek_changes()`, но выдаёт изменения в значении `bytea`.
`pg_replication_slot_advance` ( `slot_name` `name`, `upto_lsn` `pg_lsn` ) → `record` ( `slot_name` `name`, `end_lsn` `pg_lsn` ) Продвигает текущую подтверждённую позицию слота репликации с именем `slot_name`. Слот нельзя переместить назад, а также вперёд за текущую позицию добавления. Возвращает имя слота и позицию, до которой он фактически продвинулся. Информация об изменившемся положении слота, если он продвинулся, сохраняется только при ближайшей контрольной точке. Поэтому в случае прерывания работы слот может оказаться в предыдущем положении. Если указанный слот является слотом для отработки отказа логической репликации, то функция не выдаст результат, пока все физические слоты, указанные в `synchronized_standby_slots`, не подтвердят получение WAL.
`pg_replication_origin_create` ( `node_name` `text` ) → `oid` Создаёт источник репликации с заданным внешним именем и возвращает назначенный ему внутренний идентификатор. Длина имени не должна превышать 512 байт.
`pg_replication_origin_drop` ( `node_name` `text` ) → `void` Удаляет ранее созданный источник репликации, в том числе связанную информацию о воспроизведении.
`pg_replication_origin_oid` ( `node_name` `text` ) → `oid` Ищет источник репликации по имени и возвращает внутренний идентификатор. Если такой источник не находится, возвращает `NULL`.
`pg_replication_origin_session_setup` ( `node_name` `text` ) → `void` Помечает текущий сеанс как воспроизводящий изменения из указанного источника, что позволяет отслеживать процесс воспроизведения. Может применяться, только если в текущий момент источник ещё не выбран. Для отмены этого действия вызовите `pg_replication_origin_session_reset`.
`pg_replication_origin_session_reset` () → `void` Отменяет действие `pg_replication_origin_session_setup()`.
`pg_replication_origin_session_is_setup` () → `boolean` Возвращает true, если в текущем сеансе выбран источник репликации.
`pg_replication_origin_session_progress` ( `flush` `boolean` ) → `pg_lsn` Возвращает позицию воспроизведения для источника репликации, выбранного в текущем сеансе. Параметр `flush` определяет, будет ли гарантироваться сохранение локальной транзакции на диске.
`pg_replication_origin_xact_setup` ( `origin_lsn` `pg_lsn`, `origin_timestamp` `timestamp with time zone` ) → `void` Помечает текущую транзакцию как воспроизводящую транзакцию, зафиксированную с указанным LSN и временем. Может вызываться только после того, как источник репликации был выбран в результате вызова `pg_replication_origin_session_setup()`.
`pg_replication_origin_xact_reset` () → `void` Отменяет действие `pg_replication_origin_xact_setup()`.
`pg_replication_origin_advance` ( `node_name` `text`, `lsn` `pg_lsn` ) → `void` Устанавливает положение репликации для заданного узла в указанную позицию. Это в основном полезно для установки начальной позиции или новой позиции после изменения конфигурации и подобных действий. Но учтите, что неосторожное использование этой функции может привести к несогласованности реплицированных данных.
`pg_replication_origin_progress` ( `node_name` `text`, `flush` `boolean` ) → `pg_lsn` Выдаёт позицию воспроизведения для заданного источника репликации. Параметр `flush` определяет, будет ли гарантироваться сохранение локальной транзакции на диске.
`pg_logical_emit_message` ( `transactional` `boolean`, `prefix` `text`, `content` `text` [, `flush` `boolean` `DEFAULT` `false`] ) → `pg_lsn` `pg_logical_emit_message` ( `transactional` `boolean`, `prefix` `text`, `content` `bytea` [, `flush` `boolean` `DEFAULT` `false`] ) → `pg_lsn` Генерирует сообщение логического декодирования. Её можно использовать для передачи через WAL произвольных сообщений модулям логического декодирования. Параметр `transactional` определяет, должно ли сообщение относиться к текущей транзакции или оно должно записываться немедленно и декодироваться сразу, как только эта запись будет прочитана при логическом декодировании. Параметр `prefix` задаёт текстовый префикс, по которому модуль логического декодирования может легко распознать интересующие именно его сообщения. В параметре `content` передаётся содержимое сообщения, в текстовом или двоичном виде. Параметр `flush` (по умолчанию имеет значение `false`) определяет, будут ли сообщения немедленно сохраняться в WAL или нет. Параметр `flush` не работает вместе с параметром `transactional`, поскольку запись WAL сообщения сохраняется вместе с его транзакцией.
`pg_sync_replication_slots` () → `void` Синхронизирует слоты для отработки отказа логической репликации с ведущего сервера на резервный. Эта функция может выполняться только на резервном сервере. Временные синхронизированные слоты, если таковые имеются, не могут использоваться для логического декодирования и должны быть удалены после повышения. За подробностями обратитесь к Подразделу 48.2.3. Обратите внимание, что эта функция в первую очередь используется в целях тестирования и отладки, а потому должна быть использована с осторожностью. Кроме того, она не может быть выполнена, если включён параметр `sync_replication_slots` и рабочий процесс slotsync уже запущен для выполнения синхронизации слотов. Внимание Если после выполнения функции отключён параметр `hot_standby_feedback` на резервном сервере или удалён физический слот, настроенный в `primary_slot_name`, необходимые строки синхронизированного слота могут быть удалены процессом VACUUM на ведущем сервере, в результате чего синхронизированный слот будет аннулирован.

Функция

Описание

pg_create_physical_replication_slot ( slot_name name [, immediately_reserve boolean, temporary boolean] ) → record ( slot_name name, lsn pg_lsn )

Создаёт новый физический слот репликации с именем slot_name. Необязательный второй параметр, когда он равен true, указывает, что LSN для этого слота репликации должен быть зарезервирован немедленно; в противном случае LSN резервируется при первом подключении клиента потоковой репликации. Передача изменений из физического слота возможна только по протоколу потоковой репликации — см. Раздел 55.4. Необязательный третий параметр, temporary, когда он равен true, указывает, что этот слот не должен постоянно храниться на диске, так как он предназначен только для текущего сеанса. Временные слоты также освобождаются при любой ошибке. Эта функция соответствует команде протокола репликации CREATE_REPLICATION_SLOT ... PHYSICAL.

pg_drop_replication_slot ( slot_name name ) → void

Удаляет физический или логический слот репликации с именем slot_name. Соответствует команде протокола репликации DROP_REPLICATION_SLOT.

pg_create_logical_replication_slot ( slot_name name, plugin name [, temporary boolean, twophase boolean, failover boolean] ) → record ( slot_name name, lsn pg_lsn )

Создаёт новый логический (декодирующий) слот репликации с именем slot_name, используя модуль вывода plugin. Необязательный третий параметр, temporary, когда равен true, указывает, что этот слот не должен постоянно храниться на диске, так как предназначен только для текущего сеанса. Временные слоты также освобождаются при любой ошибке. Необязательный четвёртый параметр, twophase, когда равен true, указывает, что для данного слота включается декодирование подготовленных транзакций. Необязательный пятый параметр failover, когда равен true, указывает, что этот слот может быть синхронизирован с резервными серверами, чтобы логическая репликация могла быть возобновлена после отработки отказа. Вызов этой функции равнозначен выполнению команды протокола репликации CREATE_REPLICATION_SLOT ... LOGICAL.

pg_copy_physical_replication_slot ( src_slot_name name, dst_slot_name name [, temporary boolean] ) → record ( slot_name name, lsn pg_lsn )

Копирует существующий слот физической репликации с именем src_slot_name в слот с именем dst_slot_name. Скопированный слот физической репликации начинает резервировать WAL с того же последовательного номера LSN, что и исходный слот. Параметр temporary является необязательным и позволяет указать, будет ли слот временным. Если параметр temporary опущен, сохраняется то же свойство, что имеет исходный слот. Копирование аннулированного слота не допускается.

pg_copy_logical_replication_slot ( src_slot_name name, dst_slot_name name [, temporary boolean [, plugin name]] ) → record ( slot_name name, lsn pg_lsn )

Копирует существующий слот логической репликации с именем src_slot_name в слот с именем dst_slot_name, с возможностью смены модуля вывода и свойства временности. Скопированный логический слот начинает передачу с того же последовательного номера LSN, что и исходный слот. Параметры temporary и plugin являются необязательными; если они опущены, сохраняются свойства исходного слота. Параметр failover логического слота источника не копируется, и по умолчанию для него устанавливается значение false. Это позволяет устранить риск невозможности продолжить логическую репликацию после аварийного переключения на резервный сервер, с которым синхронизируется слот. Копирование аннулированного слота не допускается.

pg_logical_slot_get_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data text )

Возвращает изменения в слоте slot_name с позиции, до которой ранее были получены изменения. Если параметры upto_lsn и upto_nchanges равны NULL, логическое декодирование продолжится до конца журнала транзакций. Если upto_lsn не NULL, декодироваться будут только транзакции, зафиксированные до заданного LSN. Если upto_nchanges не NULL, декодирование остановится, когда число строк, полученных при декодировании, превысит заданное значение. Заметьте однако, что фактическое число возвращённых строк может быть больше, так как это ограничение проверяется только после добавления строк, декодированных для очередной транзакции. Если указанный слот является слотом для отработки отказа логической репликации, то функция не выдаст результат, пока все физические слоты, указанные в synchronized_standby_slots, не подтвердят получение WAL.

pg_logical_slot_peek_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data text )

Работает так же, как функция pg_logical_slot_get_changes(), но не забирает изменения; то есть, они будут получены снова при следующих вызовах.

pg_logical_slot_get_binary_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data bytea )

Работает так же, как функция pg_logical_slot_get_changes(), но выдаёт изменения в типе bytea.

pg_logical_slot_peek_binary_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data bytea )

Работает аналогично функции pg_logical_slot_peek_changes(), но выдаёт изменения в значении bytea.

pg_replication_slot_advance ( slot_name name, upto_lsn pg_lsn ) → record ( slot_name name, end_lsn pg_lsn )

Продвигает текущую подтверждённую позицию слота репликации с именем slot_name. Слот нельзя переместить назад, а также вперёд за текущую позицию добавления. Возвращает имя слота и позицию, до которой он фактически продвинулся. Информация об изменившемся положении слота, если он продвинулся, сохраняется только при ближайшей контрольной точке. Поэтому в случае прерывания работы слот может оказаться в предыдущем положении. Если указанный слот является слотом для отработки отказа логической репликации, то функция не выдаст результат, пока все физические слоты, указанные в synchronized_standby_slots, не подтвердят получение WAL.

pg_replication_origin_create ( node_name text ) → oid

Создаёт источник репликации с заданным внешним именем и возвращает назначенный ему внутренний идентификатор. Длина имени не должна превышать 512 байт.

pg_replication_origin_drop ( node_name text ) → void

Удаляет ранее созданный источник репликации, в том числе связанную информацию о воспроизведении.

pg_replication_origin_oid ( node_name text ) → oid

Ищет источник репликации по имени и возвращает внутренний идентификатор. Если такой источник не находится, возвращает NULL.

pg_replication_origin_session_setup ( node_name text ) → void

Помечает текущий сеанс как воспроизводящий изменения из указанного источника, что позволяет отслеживать процесс воспроизведения. Может применяться, только если в текущий момент источник ещё не выбран. Для отмены этого действия вызовите pg_replication_origin_session_reset.

pg_replication_origin_session_reset () → void

Отменяет действие pg_replication_origin_session_setup().

pg_replication_origin_session_is_setup () → boolean

Возвращает true, если в текущем сеансе выбран источник репликации.

pg_replication_origin_session_progress ( flush boolean ) → pg_lsn

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

pg_replication_origin_xact_setup ( origin_lsn pg_lsn, origin_timestamp timestamp with time zone ) → void

Помечает текущую транзакцию как воспроизводящую транзакцию, зафиксированную с указанным LSN и временем. Может вызываться только после того, как источник репликации был выбран в результате вызова pg_replication_origin_session_setup().

pg_replication_origin_xact_reset () → void

Отменяет действие pg_replication_origin_xact_setup().

pg_replication_origin_advance ( node_name text, lsn pg_lsn ) → void

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

pg_replication_origin_progress ( node_name text, flush boolean ) → pg_lsn

Выдаёт позицию воспроизведения для заданного источника репликации. Параметр flush определяет, будет ли гарантироваться сохранение локальной транзакции на диске.

pg_logical_emit_message ( transactional boolean, prefix text, content text [, flush boolean DEFAULT false] ) → pg_lsn

pg_logical_emit_message ( transactional boolean, prefix text, content bytea [, flush boolean DEFAULT false] ) → pg_lsn

Генерирует сообщение логического декодирования. Её можно использовать для передачи через WAL произвольных сообщений модулям логического декодирования. Параметр transactional определяет, должно ли сообщение относиться к текущей транзакции или оно должно записываться немедленно и декодироваться сразу, как только эта запись будет прочитана при логическом декодировании. Параметр prefix задаёт текстовый префикс, по которому модуль логического декодирования может легко распознать интересующие именно его сообщения. В параметре content передаётся содержимое сообщения, в текстовом или двоичном виде. Параметр flush (по умолчанию имеет значение false) определяет, будут ли сообщения немедленно сохраняться в WAL или нет. Параметр flush не работает вместе с параметром transactional, поскольку запись WAL сообщения сохраняется вместе с его транзакцией.

pg_sync_replication_slots () → void

Синхронизирует слоты для отработки отказа логической репликации с ведущего сервера на резервный. Эта функция может выполняться только на резервном сервере. Временные синхронизированные слоты, если таковые имеются, не могут использоваться для логического декодирования и должны быть удалены после повышения. За подробностями обратитесь к Подразделу 48.2.3. Обратите внимание, что эта функция в первую очередь используется в целях тестирования и отладки, а потому должна быть использована с осторожностью. Кроме того, она не может быть выполнена, если включён параметр sync_replication_slots и рабочий процесс slotsync уже запущен для выполнения синхронизации слотов.

Внимание

Если после выполнения функции отключён параметр hot_standby_feedback на резервном сервере или удалён физический слот, настроенный в primary_slot_name, необходимые строки синхронизированного слота могут быть удалены процессом VACUUM на ведущем сервере, в результате чего синхронизированный слот будет аннулирован.

9.28.7. Функции управления объектами баз данных #

Функции, показанные в Таблице 9.102, вычисляют объём, который занимают на диске объекты базы данных, и помогают воспринять и проанализировать информацию об используемом объёме. Результаты типа bignit представляют значения в байтах. Если им передаётся OID, не соответствующий существующему объекту, эти функции возвращают NULL.

Таблица 9.102. Функции получения размера объектов БД

Функция Описание
`pg_column_size` ( `"any"` ) → `integer` Показывает, сколько байт занимает при хранении отдельное значение. Если эта функция применяется непосредственно к значению в столбце таблицы, в результате отражается эффект возможного сжатия.
`pg_column_compression` ( `"any"` ) → `text` Показывает алгоритм сжатия, который использовался для сжатия отдельного значения переменной длины. Возвращает `NULL`, если значение не сжато.
`pg_column_toast_chunk_id` ( `"any"` ) → `oid` Показывает `chunk_id` значения в формате TOAST на диске. Возвращает `NULL`, если значение не в формате TOAST или не хранится на диске. За более подробным описанием TOAST обратитесь к Разделу 65.2.
`pg_database_size` ( `name` ) → `bigint` `pg_database_size` ( `oid` ) → `bigint` Вычисляет общий объём, который занимает на диске база данных с указанным именем или OID. Для использования этой функции необходимо иметь право `CONNECT` для заданной базы (оно даётся по умолчанию) или иметь права роли `pg_read_all_stats`.
`pg_indexes_size` ( `regclass` ) → `bigint` Вычисляет общий объём, который занимают на диске индексы, связанные с указанной таблицей.
`pg_relation_size` ( `relation` `regclass` [, `fork` `text`] ) → `bigint` Вычисляет объём, который занимает на диске один «слой» заданного отношения. (Заметьте, что в большинстве случаев удобнее использовать более высокоуровневые функции `pg_total_relation_size` и `pg_table_size`, которые суммируют размер всех слоёв.) С одним аргументом она выдаёт размер основного слоя с данными отношения. Название другого интересующего слоя можно передать во втором аргументе: `main` выдаёт размер основного слоя данных заданного отношения. `fsm` выдаёт размер карты свободного места (см. Раздел 65.3), связанной с заданным отношением. `vm` выдаёт размер карты видимости (см. Раздел 65.4), связанной с заданным отношением. `init` выдаёт размер слоя инициализации для заданного отношения, если он имеется.
`pg_size_bytes` ( `text` ) → `bigint` Преобразует размер в понятном человеку формате (который выдаёт `pg_size_pretty`) в число байт. Возможные единицы: `bytes`, `B`, `kB`, `MB`, `GB`, `TB` и `PB`.
`pg_size_pretty` ( `bigint` ) → `text` `pg_size_pretty` ( `numeric` ) → `text` Преобразует размер в байтах в более понятный человеку формат с единицами измерения размера (bytes, kB, MB, GB, TB или PB, в зависимости от значения). Заметьте, что эти единицы определяются как степени 2, а не 10, так что 1kB — это 1024 байта, 1MB — 1024² = 1048576 байт и т. д.
`pg_table_size` ( `regclass` ) → `bigint` Вычисляет объём, который занимает на диске данная таблица, за исключением индексов (но включая её TOAST-таблицу (если она есть), карту свободного места и карту видимости).
`pg_tablespace_size` ( `name` ) → `bigint` `pg_tablespace_size` ( `oid` ) → `bigint` Вычисляет общий объём, который занимает на диске табличное пространство с заданным именем или OID. Для использования этой функции требуется иметь право `CREATE` для указанного табличного пространства или иметь права роли `pg_read_all_stats`, если только это не табличное пространство по умолчанию для текущей базы данных.
`pg_total_relation_size` ( `regclass` ) → `bigint` Вычисляет общий объём, который занимает на диске заданная таблица, включая все её индексы и данные TOAST. Результат этой функции равен значению `pg_table_size` `+` `pg_indexes_size`.

Функция

Описание

pg_column_size ( "any" ) → integer

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

pg_column_compression ( "any" ) → text

Показывает алгоритм сжатия, который использовался для сжатия отдельного значения переменной длины. Возвращает NULL, если значение не сжато.

pg_column_toast_chunk_id ( "any" ) → oid

Показывает chunk_id значения в формате TOAST на диске. Возвращает NULL, если значение не в формате TOAST или не хранится на диске. За более подробным описанием TOAST обратитесь к Разделу 65.2.

pg_database_size ( name ) → bigint

pg_database_size ( oid ) → bigint

Вычисляет общий объём, который занимает на диске база данных с указанным именем или OID. Для использования этой функции необходимо иметь право CONNECT для заданной базы (оно даётся по умолчанию) или иметь права роли pg_read_all_stats.

pg_indexes_size ( regclass ) → bigint

Вычисляет общий объём, который занимают на диске индексы, связанные с указанной таблицей.

pg_relation_size ( relation regclass [, fork text] ) → bigint

Вычисляет объём, который занимает на диске один «слой» заданного отношения. (Заметьте, что в большинстве случаев удобнее использовать более высокоуровневые функции pg_total_relation_size и pg_table_size, которые суммируют размер всех слоёв.) С одним аргументом она выдаёт размер основного слоя с данными отношения. Название другого интересующего слоя можно передать во втором аргументе:

main выдаёт размер основного слоя данных заданного отношения.
fsm выдаёт размер карты свободного места (см. Раздел 65.3), связанной с заданным отношением.
vm выдаёт размер карты видимости (см. Раздел 65.4), связанной с заданным отношением.
init выдаёт размер слоя инициализации для заданного отношения, если он имеется.

pg_size_bytes ( text ) → bigint

Преобразует размер в понятном человеку формате (который выдаёт pg_size_pretty) в число байт. Возможные единицы: bytes, B, kB, MB, GB, TB и PB.

pg_size_pretty ( bigint ) → text

pg_size_pretty ( numeric ) → text

Преобразует размер в байтах в более понятный человеку формат с единицами измерения размера (bytes, kB, MB, GB, TB или PB, в зависимости от значения). Заметьте, что эти единицы определяются как степени 2, а не 10, так что 1kB — это 1024 байта, 1MB — 1024² = 1048576 байт и т. д.

pg_table_size ( regclass ) → bigint

Вычисляет объём, который занимает на диске данная таблица, за исключением индексов (но включая её TOAST-таблицу (если она есть), карту свободного места и карту видимости).

pg_tablespace_size ( name ) → bigint

pg_tablespace_size ( oid ) → bigint

Вычисляет общий объём, который занимает на диске табличное пространство с заданным именем или OID. Для использования этой функции требуется иметь право CREATE для указанного табличного пространства или иметь права роли pg_read_all_stats, если только это не табличное пространство по умолчанию для текущей базы данных.

pg_total_relation_size ( regclass ) → bigint

Вычисляет общий объём, который занимает на диске заданная таблица, включая все её индексы и данные TOAST. Результат этой функции равен значению pg_table_size + pg_indexes_size.

Вышеописанные функции, работающие с таблицами или индексами, принимают аргумент типа regclass, который представляет собой просто OID таблицы или индекса в системном каталоге pg_class. Однако вам не нужно вручную вычислять OID, так как процедура ввода значения regclass может сделать это за вас. За подробностями обратитесь к Разделу 8.19.

Функции, перечисленные в Таблице 9.103, помогают определить, в каких файлах на диске хранятся объекты базы данных.

Таблица 9.103. Функции определения расположения объектов

Функция Описание
`pg_relation_filenode` ( `relation` `regclass` ) → `oid` Выдаёт номер «файлового узла», связанного с заданным объектом. Файловым узлом называется основной компонент имени файла, используемого для хранения данных (подробнее это описано в Разделе 65.1). Для большинства отношений этот номер совпадает со значением `pg_class`.`relfilenode`, но для некоторых системных каталогов `relfilenode` равен 0, и нужно использовать эту функцию, чтобы узнать действительное значение. Если указанное отношение не хранится на диске, как, например представление, данная функция возвращает NULL.
`pg_relation_filepath` ( `relation` `regclass` ) → `text` Выдаёт полный путь к файлу отношения (относительно каталога данных `PGDATA`).
`pg_filenode_relation` ( `tablespace` `oid`, `filenode` `oid` ) → `regclass` Выдаёт OID отношения, которое хранится в табличном пространстве, заданном по OID, в указанном файловом узле. По сути эта функция является обратной к `pg_relation_filepath`. Для табличного пространства по умолчанию можно передать нулевое значение OID. Если эта функция не находит в базе данных отношение по заданным значениям или если отношение является временным, она выдаёт `NULL`.

Функция

Описание

pg_relation_filenode ( relation regclass ) → oid

Выдаёт номер «файлового узла», связанного с заданным объектом. Файловым узлом называется основной компонент имени файла, используемого для хранения данных (подробнее это описано в Разделе 65.1). Для большинства отношений этот номер совпадает со значением pg_class.relfilenode, но для некоторых системных каталогов relfilenode равен 0, и нужно использовать эту функцию, чтобы узнать действительное значение. Если указанное отношение не хранится на диске, как, например представление, данная функция возвращает NULL.

pg_relation_filepath ( relation regclass ) → text

Выдаёт полный путь к файлу отношения (относительно каталога данных PGDATA).

pg_filenode_relation ( tablespace oid, filenode oid ) → regclass

Выдаёт OID отношения, которое хранится в табличном пространстве, заданном по OID, в указанном файловом узле. По сути эта функция является обратной к pg_relation_filepath. Для табличного пространства по умолчанию можно передать нулевое значение OID. Если эта функция не находит в базе данных отношение по заданным значениям или если отношение является временным, она выдаёт NULL.

В Таблица 9.104 перечислены функции, предназначенные для управления правилами сортировки.

Таблица 9.104. Функции управления правилами сортировки

Функция Описание
`pg_collation_actual_version` ( `oid` ) → `text` Возвращает действующую версию объекта правила сортировки, которая в настоящее время установлена в операционной системе. Если она отличается от значения в `pg_collation`.`collversion`, может потребоваться перестроить объекты, зависящие от данного правила сортировки. См. также ALTER COLLATION.
`pg_database_collation_actual_version` ( `oid` ) → `text` Возвращает действующую версию правила сортировки БД, установленную на данный момент в операционной системе. Если она отличается от значения в `pg_database`.`datcollversion`, может потребоваться перестроить объекты, зависящие от данного правила сортировки. См. также ALTER DATABASE.
`pg_import_system_collations` ( `s`

Функция

Описание

pg_collation_actual_version ( oid ) → text

Возвращает действующую версию объекта правила сортировки, которая в настоящее время установлена в операционной системе. Если она отличается от значения в pg_collation.collversion, может потребоваться перестроить объекты, зависящие от данного правила сортировки. См. также ALTER COLLATION.

pg_database_collation_actual_version ( oid ) → text

Возвращает действующую версию правила сортировки БД, установленную на данный момент в операционной системе. Если она отличается от значения в pg_database.datcollversion, может потребоваться перестроить объекты, зависящие от данного правила сортировки. См. также ALTER DATABASE.

pg_import_system_collations ( s