pg_standby
pg_standby — поддерживает создание сервера тёплого резерва Postgres Pro
Синтаксис
pg_standby
[параметр
...] расположение_архива
следующий_файл_wal
каталог_wal
[файл_перезапуска_wal
]
Описание
Программа pg_standby поддерживает создание сервера в режиме «тёплого резерва». Она предназначена как для непосредственного применения в производственной среде, так и для использования в качестве настраиваемой заготовки, когда требуются специальные модификации.
pg_standby ожидает выполнения команды restore_command
, которая, в свою очередь, нужна для перехода от стандартного восстановления архива к режиму тёплого резерва. Для этого также требуется другая настройка, которая описывается в основном руководстве сервера (см. Раздел 25.2).
Чтобы настроить резервный сервер на использование pg_standby, поместите эту строку в его файл конфигурации postgresql.conf
:
restore_command = 'pg_standby каталог_архива
%f %p %r'
Здесь каталог_архива
— каталог, из которого должны восстанавливаться сегменты WAL.
Если указывается файл_перезапуска_wal
, обычно с помощью макроса %r
, тогда все файлы WAL, предшествующие указанному, будут удалены из каталога расположение_архива
. Это позволяет сократить число сохраняемых файлов без потери возможности восстановления при перезапуске. Такой вариант использования уместен, когда расположение_архива
указывает на область рабочих файлов конкретного резервного сервера, но не когда расположение_архива
— каталог с архивом WAL для долговременного хранения.
pg_standby рассчитывает на то, что расположение_архива
доступно для чтения пользователю, владеющему серверным процессом. Если указывается файл_перезапуска_wal
(или -k
), каталог расположение_архива
должен быть также доступен для записи.
При отказе ведущего сервера переключение на сервер «тёплого резерва» возможно двумя способами:
- Умное переключение
При умном переключении сервер включается в работу, применив изменения из всех файлов WAL, имеющихся в архиве. В результате никакие данные не теряются, даже если данный резервный сервер отстал, но если применить нужно большое количество изменений WAL, подготовка к работе может быть длительной. Чтобы вызвать умное переключение, создайте файл-триггер, содержащий слово
smart
, либо просто пустой файл.- Быстрое переключение
При быстром переключении сервер включается в работу немедленно. Все ещё не применённые файлы WAL в архиве будут игнорироваться, и все транзакции в этих файлах будут потеряны. Чтобы вызвать быстрое переключение, создайте файл-триггер и запишите в него слово
fast
. Программу pg_standby можно также настроить так, чтобы быстрое переключение происходило автоматически, если за определённое время не появляется новый файл WAL.
Параметры
pg_standby принимает следующие аргументы командной строки:
-c
Применять для восстановления файлов WAL из архива команду
cp
илиcopy
. На данный момент поддерживается только это поведение, так что этот параметр бесполезен.-d
Выводить подробные отладочные сообщения в
stderr
.-k
Удалить файлы из каталога
расположение_архива
, чтобы в нём осталось не больше заданного числа файлов WAL, предшествующих текущему. Ноль (по умолчанию) означает, что не нужно удалять никакие файлы из каталогарасположение_архива
. Этот параметр будет просто игнорироваться, если указанфайл_перезапуска_wal
, так как этот метод более точно определяет правильную точку отсечения архива. Этот параметр считается устаревшим с PostgreSQL 8.3; надёжнее и эффективнее использовать параметрфайл_перезапуска_wal
. При слишком маленьком значении данного параметра могут быть удалены файлы, требующиеся для перезапуска резервного сервера, тогда как при слишком большом будет неэффективно расходоваться место в архиве.-r
макс_повторов
Устанавливает, сколько раз максимум нужно повторять команду copy в случае ошибки (по умолчанию 3). После каждой ошибки программа приостанавливается на
время_задержки
*число_повторов
, так что время ожидания постепенно увеличивается. По умолчанию она ждёт 5, 10, затем 15 секунд, и только потом сообщает резервному серверу об ошибке. Это событие будет воспринято как завершение восстановления, и в результате резервный сервер полностью включится в работу.-s
время_задержки
Задаёт количество секунд (до 60, по умолчанию 5) для паузы между проверками наличия файла WAL в архиве. Значение по умолчанию не обязательно наилучшее; за подробностями обратитесь к Разделу 25.2.
-t
файл_триггер
Указывает файл-триггер, при появлении которого должна начаться отработка отказа. Имя этого файла рекомендуется выбирать по определённой схеме, позволяющей однозначно понять, для какого сервера вызывается отработка отказа, когда таких серверов в одной системе несколько; например,
/tmp/pgsql.trigger.5432
.-V
--version
Вывести версию pg_standby и завершиться.
-w
макс_время_ожидания
Задаёт максимальное время ожидания (в секундах) следующего файла WAL, по истечении которого будет произведено быстрое переключение. При нуле (значении по умолчанию) ожидание бесконечно. Значение по умолчанию не обязательно наилучшее; за подробностями обратитесь к Разделу 25.2.
-?
--help
Вывести справку об аргументах командной строки pg_standby и завершиться.
Примечания
Программа pg_standby предназначена для работы с PostgreSQL 8.2 и новее.
С PostgreSQL, начиная с 8.3, можно использовать макрос %r
, который позволяет pg_standby узнать, какой последний файл нужно сохранять. Для PostgreSQL 8.2, если требуется очищать архив, нужно применять параметр -k
. Этот параметр сохранился и после 8.3, но теперь он считается устаревшим.
PostgreSQL, начиная с 8.4, поддерживает параметр recovery_end_command
. В нём можно задать команду, удаляющую файл-триггер во избежание ошибок.
Программа pg_standby написана на C; её исходный код легко поддаётся модификации (он содержит секции, предназначенные для изменения при надобности)
Примеры
В системах Linux или Unix можно использовать команды:
archive_command = 'cp %p .../archive/%f' restore_command = 'pg_standby -d -s 2 -t /tmp/pgsql.trigger.5442 .../archive %f %p %r 2>>standby.log' recovery_end_command = 'rm -f /tmp/pgsql.trigger.5442'
Предполагается, что каталог архива физически располагается на резервном сервере, так что команда archive_command
обращается к нему по NFS, но для резервного сервера эти файлы локальные (для этого применяется ln
). Эти команды будут:
выводить отладочную информацию в
standby.log
ждать 2 секунды между проверками появления следующего файла WAL
прекращать ожидание, только когда появляется файл-триггер с именем
/tmp/pgsql.trigger.5442
, и выполнить переключение согласно его содержимомуудалять файл-триггер по завершении восстановления
удалять ставшие ненужными файлы из каталога архива
В Windows можно использовать такие команды:
archive_command = 'copy %p ...\\archive\\%f' restore_command = 'pg_standby -d -s 5 -t C:\pgsql.trigger.5442 ...\archive %f %p %r 2>>standby.log' recovery_end_command = 'del C:\pgsql.trigger.5442'
Заметьте, что обратную косую черту нужно дублировать в archive_command
, но не в restore_command
или recovery_end_command
. Эти команды будут:
применять команду
copy
для восстановления файлов WAL из архивавыводить отладочную информацию в
standby.log
ждать 5 секунд между проверками появления следующего файла WAL
прекращать ожидание, только когда появляется файл-триггер с именем
C:\pgsql.trigger.5442
, и выполнить переключение согласно его содержимомуудалять файл-триггер по завершении восстановления
удалять ставшие ненужными файлы из каталога архива
Команда copy
в Windows устанавливает окончательный размер файла до того, как файл будет окончательно скопирован, что обычно сбивает с толку pg_standby. Поэтому pg_standby ждёт время_задержки
после того, как увидит подходящий размер файла. Команда cp
из GNUWin32 устанавливает размер файла, только когда завершает копирование.
Так как в примере для Windows с обеих сторон применяется copy
, любой или оба этих сервера могут обращаться к каталогу архива по сети.
Автор
Саймон Риггс <simon@2ndquadrant.com>
См. также
pg_archivecleanupSPI_prepare
SPI_prepare — prepare a statement, without executing it yet
Synopsis
SPIPlanPtr SPI_prepare(const char *command
, intnargs
, Oid *argtypes
)
Description
SPI_prepare
creates and returns a prepared statement for the specified command, but doesn't execute the command. The prepared statement can later be executed repeatedly using SPI_execute_plan
.
When the same or a similar command is to be executed repeatedly, it is generally advantageous to perform parse analysis only once, and might furthermore be advantageous to re-use an execution plan for the command. SPI_prepare
converts a command string into a prepared statement that encapsulates the results of parse analysis. The prepared statement also provides a place for caching an execution plan if it is found that generating a custom plan for each execution is not helpful.
A prepared command can be generalized by writing parameters ($1
, $2
, etc.) in place of what would be constants in a normal command. The actual values of the parameters are then specified when SPI_execute_plan
is called. This allows the prepared command to be used over a wider range of situations than would be possible without parameters.
The statement returned by SPI_prepare
can be used only in the current invocation of the C function, since SPI_finish
frees memory allocated for such a statement. But the statement can be saved for longer using the functions SPI_keepplan
or SPI_saveplan
.
Arguments
const char *
command
command string
int
nargs
number of input parameters (
$1
,$2
, etc.)Oid *
argtypes
pointer to an array containing the OIDs of the data types of the parameters
Return Value
SPI_prepare
returns a non-null pointer to an SPIPlan
, which is an opaque struct representing a prepared statement. On error, NULL
will be returned, and SPI_result
will be set to one of the same error codes used by SPI_execute
, except that it is set to SPI_ERROR_ARGUMENT
if command
is NULL
, or if nargs
is less than 0, or if nargs
is greater than 0 and argtypes
is NULL
.
Notes
If no parameters are defined, a generic plan will be created at the first use of SPI_execute_plan
, and used for all subsequent executions as well. If there are parameters, the first few uses of SPI_execute_plan
will generate custom plans that are specific to the supplied parameter values. After enough uses of the same prepared statement, SPI_execute_plan
will build a generic plan, and if that is not too much more expensive than the custom plans, it will start using the generic plan instead of re-planning each time. If this default behavior is unsuitable, you can alter it by passing the CURSOR_OPT_GENERIC_PLAN
or CURSOR_OPT_CUSTOM_PLAN
flag to SPI_prepare_cursor
, to force use of generic or custom plans respectively.
Although the main point of a prepared statement is to avoid repeated parse analysis and planning of the statement, Postgres Pro will force re-analysis and re-planning of the statement before using it whenever database objects used in the statement have undergone definitional (DDL) changes since the previous use of the prepared statement. Also, if the value of search_path changes from one use to the next, the statement will be re-parsed using the new search_path
. (This latter behavior is new as of PostgreSQL 9.3.) See PREPARE for more information about the behavior of prepared statements.
This function should only be called from a connected C function.
SPIPlanPtr
is declared as a pointer to an opaque struct type in spi.h
. It is unwise to try to access its contents directly, as that makes your code much more likely to break in future revisions of Postgres Pro.
The name SPIPlanPtr
is somewhat historical, since the data structure no longer necessarily contains an execution plan.