Настройте SSH #

Если вы хотите использовать pg_probackup в удалённом режиме (применяя SSH), выполните следующие действия:

pg_probackup работает в удалённом режиме по протоколу SSH следующим образом:

Настройка подключения к хранилищу S3 #

Если вы хотите использовать pg_probackup с интерфейсом S3, выполните следующие действия:

Режим ARCHIVE #

Режим ARCHIVE используется в качестве режима доставки WAL по умолчанию.

Например, чтобы сделать полную копию в режиме доставки WAL ARCHIVE, выполните:

pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL

Резервное копирование ARCHIVE требует организации непрерывного архивирования, посредством которого считываются сегменты WAL, требующиеся для восстановления согласованного состояния кластера на момент создания копии.

В процессе резервного копирования pg_probackup помещает файлы WAL, содержащие записи от Start LSN до Stop LSN, в каталог каталог_копий/wal/имя_экземпляра. pg_probackup также проверяет, что записи WAL между Start LSN и Stop LSN корректно читаются. Это позволяет исключить риск хранения в архиве повреждённого WAL.

Режим STREAM #

Режим STREAM может использоваться в качестве альтернативного режима доставки WAL.

Например, чтобы сделать полную резервную копию в потоковом режиме, добавьте флаг --stream к команде, показанной выше:

pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL --stream --temp-slot

Необязательный параметр --temp-slot обеспечивает наличие необходимых сегментов в случае прокрутки WAL до завершения резервного копирования.

В отличие от копий ARCHIVE, копии типа STREAM включают все сегменты WAL, необходимые для восстановления согласованного состояния кластера на момент создания копии.

В процессе выполнения команды backup программа pg_probackup передаёт файлы WAL, содержащие записи от Start LSN до Stop LSN в каталог каталог_копий/backups/имя_экземпляра/ид_резервной_копии/database/pg_wal. Чтобы исключить риск архивирования испорченных файлов WAL, pg_probackup также проверяет, что записи WAL от Start LSN до Stop LSN прочитываются корректно.

Даже если вы используете непрерывное архивирование, копирование в режиме STREAM может быть полезно в следующих случаях:

Проверка страниц #

Когда в кластере БД включены контрольные суммы, pg_probackup использует их для проверки целостности файлов данных в процессе резервного копирования. При чтении каждой страницы pg_probackup проверяет, совпадает ли вычисленная сумма с контрольной суммой, хранящейся в заголовке страницы. Это гарантирует, что в кластере Postgres Pro и самой резервной копии не содержатся испорченные страницы. Заметьте, что pg_probackup читает файлы данных непосредственно из файловой системы, поэтому при активной записи в момент копирования возможны ложные выявления некорректных контрольных сумм из-за частичной записи. В случае несовпадения контрольной суммы страница считывается повторно, и контрольная сумма проверяется ещё раз.

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

Даже если контрольные суммы не включены, pg_probackup всегда проверяет целостность заголовков страниц.

Внешние каталоги #

Чтобы заархивировать каталог, размещённый вне каталога данных, воспользуйтесь необязательным параметром --external-dirs, в котором можно задать путь к нужному каталогу. Если вы хотите заархивировать несколько внешних каталогов, их пути нужно разделить двоеточиями в Linux или точками с запятой в Windows.

Например, чтобы в системе Linux включить каталоги /etc/dir1 и /etc/dir2 в полную копию экземпляра имя_экземпляра, которая будет размещаться в каталоге_копий, выполните:

pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL --external-dirs=/etc/dir1:/etc/dir2

Например, чтобы включить каталоги C:\dir1 и C:\dir2 в полную копию, в Windows нужно выполнить:

pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL --external-dirs=C:\dir1;C:\dir2

Для каждого внешнего каталога pg_probackup создаёт отдельный подкаталог в каталоге резервной копии и рекурсивно копирует в него всё содержимое внешнего каталога. Так как внешние каталоги, попадающие в разные резервные копии, не обязательно должны быть одинаковыми, при восстановлении кластера из инкрементальной копии будут восстановлены только те каталоги, которые относятся именно к ней. Внешние каталоги, сохранённые в предыдущих копиях, восстановлены не будут.

Чтобы нужные каталоги включались в каждую резервную копию вашего кластера, их список можно сохранить в файле конфигурации pg_probackup.conf, воспользовавшись командой set-config с ключом --external-dirs.

Инкрементальное восстановление #

Скорость восстановления резервной копии можно значительно увеличить, заменяя в существующем каталоге данных Postgres Pro только некорректные или изменённые страницы. Это можно реализовать, используя параметры инкрементального восстановления с командой restore.

Чтобы восстановить кластер баз данных из резервной копии в инкрементальном режиме, выполните команду restore со следующими параметрами:

pg_probackup restore -B каталог_копий --instance=имя_экземпляра -D каталог_данных -I инкрементальный_режим
      

Здесь инкрементальный_режим может быть следующим:

Вне зависимости от выбранного инкрементального режима, pg_probackup будет проверять, что с заданным целевым каталогом не работает процесс postmaster и значения system-identifier в целевом экземпляре и копии совпадают.

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

==================================================================================================================================================
 Instance  Version  ID      Recovery Time                  Mode    WAL Mode  TLI  Time   Data   WAL  Zalg  Zratio  Start LSN   Stop LSN    Status 
==================================================================================================================================================
 node      17       SBOL8S  2024-04-09 18:19:43.707720+03  DELTA   STREAM    16/15    3s  114MB  64MB   lz4    1.42  0/3C003020  0/3E8D4930  OK     
 node      17       SBOL8G  2024-04-09 18:19:32.594670+03  PTRACK  STREAM    15/15    4s   30MB  16MB  zlib    2.23  0/31000028  0/310029E0  OK     
 node      17       SBOL83  2024-04-09 18:19:22.269595+03  PAGE    STREAM    15/15    7s   46MB  32MB  pglz    1.44  0/29000028  0/2A0000F8  OK     
 node      17       SBOL7P  2024-04-09 18:19:06.557301+03  FULL    STREAM    15/0     6s  144MB  16MB  zstd    2.47  0/22000028  0/220001C8  OK     

backup_user@backup_host:~$ pg_probackup restore -B /mnt/backups --instance=node -R -I lsn
INFO: Destination directory and tablespace directories are empty, disable incremental restore
INFO: Validating parents for backup SBOL8S
INFO: Validating backup SBOL7P
INFO: Backup SBOL7P data files are valid
INFO: Validating backup SBOL83
INFO: Backup SBOL83 data files are valid
INFO: Validating backup SBOL8G
INFO: Backup SBOL8G data files are valid
INFO: Validating backup SBOL8S
INFO: Backup SBOL8S data files are valid
INFO: Backup SBOL8S WAL segments are valid
INFO: Backup SBOL8S is valid.
INFO: Restoring the database from the backup starting at 2024-04-09 18:19:40+03
INFO: Start restoring backup files. PGDATA size: 616MB
INFO: Backup files are restored. Transferred bytes: 616MB, time elapsed: 2s
INFO: Restore incremental ratio (less is better): 100% (616MB/616MB)
INFO: Syncing restored files to disk
INFO: Restored backup files are synced, time elapsed: 2s
INFO: Restore of backup SBOL8S completed.

Частичное восстановление #

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

Чтобы восстановить только некоторые базы данных, выполните команду restore как минимум со следующими параметрами:

pg_probackup restore -B каталог_копий --instance=имя_экземпляра --db-include=имя_базы
      

Ключ --db-include может добавляться многократно. Например, чтобы восстановить только базы db1 и db2, выполните следующую команду:

pg_probackup restore -B каталог_копий --instance=имя_экземпляра --db-include=db1 --db-include=db2

Чтобы исключить одну или несколько баз из числа восстанавливаемых, используйте ключ --db-exclude:

pg_probackup restore -B каталог_копий --instance=имя_экземпляра --db-exclude=имя_базы

Ключ --db-exclude может добавляться многократно. Например, чтобы при восстановлении исключить базы данных db1 и db2, выполните следующую команду:

pg_probackup restore -B каталог_копий --instance=имя_экземпляра --db-exclude=db1 --db-exclude=db2

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

Чтобы максимально быстро разделить один кластер, содержащий несколько баз данных, на разные кластеры, можно выполнить частичное восстановление исходного кластера в виде ведомого, передав ключ --restore-as-replica для определённых баз данных.

Просмотр информации о резервных копиях #

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

pg_probackup show -B каталог_копий

pg_probackup выводит список всех имеющихся резервных копий. Например:

BACKUP INSTANCE 'node'
==================================================================================================================================================
 Instance  Version  ID      Recovery Time                  Mode    WAL Mode  TLI  Time   Data   WAL  Zalg  Zratio  Start LSN   Stop LSN    Status
==================================================================================================================================================
 node      17       SBOL94  2024-04-09 18:19:56.603355+03  FULL    ARCHIVE   1/0    6s  377MB  16MB   lz4    1.46  0/41000028  0/420000C0  OK
 node      17       SBOL8S  2024-04-09 18:19:43.707720+03  DELTA   STREAM    1/1    3s  114MB  64MB   lz4    1.42  0/3C003020  0/3E8D4930  OK
 node      17       SBOL8G  2024-04-09 18:19:32.594670+03  PTRACK  STREAM    1/1    4s   30MB  16MB  zlib    2.23  0/31000028  0/310029E0  OK
 node      17       SBOL83  2024-04-09 18:19:22.269595+03  PAGE    STREAM    1/1    7s   46MB  32MB  pglz    1.44  0/29000028  0/2A0000F8  OK
 node      17       SBOL7P  2024-04-09 18:19:06.557301+03  FULL    STREAM    1/0    6s  144MB  16MB  zstd    2.47  0/22000028  0/220001C8  OK

Для каждой копии выдаются следующие сведения:

Восстановить кластер из копии можно только для копий с состоянием OK или DONE.

Чтобы получить более подробную информацию о копии, укажите в команде show её идентификатор:

pg_probackup show -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии

Пример вывода:

#Configuration
backup-mode = FULL
stream = false
compress-alg = lz4
compress-level = 1
from-replica = false

#Compatibility
block-size = 8192
xlog-block-size = 8192
checksum-version = 1
program-version = 2.7.3
server-version = 17

#Result backup info
timelineid = 1
start-lsn = 0/41000028
stop-lsn = 0/420000C0
start-time = '2024-04-09 18:19:52+03'
end-time = '2024-04-09 18:19:58+03'
end-validation-time = '2024-04-09 18:19:59+03'
recovery-xid = 757
recovery-time = '2024-04-09 18:19:56.603355+03'
data-bytes = 395651278
wal-bytes = 16777216
uncompressed-bytes = 578552566
pgdata-bytes = 578552248
status = OK
primary_conninfo = 'user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable'
content-crc = 3862224379

В расширенном выводе представлены дополнительные атрибуты:

Вы также можете получить подробную информацию о резервной копии в формате JSON:

pg_probackup show -B каталог_копий --instance=имя_экземпляра --format=json -i backup_id

Пример вывода:

[
    {
        "instance": "node",
        "backups": [
            {
                "id": "SBOL94",
                "status": "OK",
                "start-time": "2024-04-09 18:19:52+03",
                "backup-mode": "FULL",
                "wal": "ARCHIVE",
                "compress-alg": "lz4",
                "compress-level": 1,
                "from-replica": "false",
                "block-size": 8192,
                "xlog-block-size": 8192,
                "checksum-version": 1,
                "program-version": "2.7.3",
                "server-version": "17",
                "current-tli": 16,
                "parent-tli": 2,
                "start-lsn": "0/41000028",
                "stop-lsn": "0/420000C0",
                "end-time": "2024-04-09 18:19:58+03",
                "end-validation-time": "2024-04-09 18:19:59+03",
                "recovery-xid": 757,
                "recovery-time": "2024-04-09 18:19:56.603355+03",
                "data-bytes": 395651278,
                "wal-bytes": 16777216,
                "uncompressed-bytes": 578552566,
                "pgdata-bytes": 578552248,
                "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                "content-crc": 3862224379
            }
        ]
    }
]

Просмотр оглавления архива WAL #

Чтобы получить информацию об архиве WAL для каждого экземпляра, выполните команду:

pg_probackup show -B каталог_копий [--instance=имя_экземпляра] --archive

pg_probackup выводит список всех имеющихся файлов WAL, сгруппированных по линиям времени. Например:

INFO: checking WAL file name "00000001000000000000001B"
INFO: checking WAL file name "00000001000000000000001C"
INFO: checking WAL file name "00000001000000000000001D"
INFO: checking WAL file name "00000001000000000000001E"
INFO: checking WAL file name "00000001000000000000001F"
INFO: checking WAL file name "000000010000000000000020"
INFO: checking WAL file name "000000010000000000000021"
INFO: checking WAL file name "000000010000000000000022"
INFO: checking WAL file name "000000010000000000000022.00000028.backup"
INFO: checking WAL file name "000000010000000000000023"
INFO: checking WAL file name "000000010000000000000024"
INFO: checking WAL file name "000000010000000000000025"
INFO: checking WAL file name "000000010000000000000026"
INFO: checking WAL file name "000000010000000000000027"
INFO: checking WAL file name "000000010000000000000028"
INFO: checking WAL file name "000000010000000000000029"
INFO: checking WAL file name "000000010000000000000029.00000028.backup"
INFO: checking WAL file name "00000001000000000000002A"
INFO: checking WAL file name "00000001000000000000002B"
INFO: checking WAL file name "00000001000000000000002C"
INFO: checking WAL file name "00000001000000000000002D"
INFO: checking WAL file name "00000001000000000000002E"
INFO: checking WAL file name "00000001000000000000002F"
INFO: checking WAL file name "000000010000000000000030"
INFO: checking WAL file name "000000010000000000000031"
INFO: checking WAL file name "000000010000000000000031.00000028.backup"
INFO: checking WAL file name "000000010000000000000032"
INFO: checking WAL file name "000000010000000000000033"
INFO: checking WAL file name "000000010000000000000034"
INFO: checking WAL file name "000000010000000000000035"
INFO: checking WAL file name "000000010000000000000036"
INFO: checking WAL file name "000000010000000000000037"
INFO: checking WAL file name "000000010000000000000038"
INFO: checking WAL file name "000000010000000000000039"
INFO: checking WAL file name "00000001000000000000003A"
INFO: checking WAL file name "00000001000000000000003B"
INFO: checking WAL file name "00000001000000000000003C"
INFO: checking WAL file name "00000001000000000000003C.00003020.backup"
INFO: checking WAL file name "00000001000000000000003D"
INFO: checking WAL file name "00000001000000000000003E"
INFO: checking WAL file name "00000001000000000000003F"
INFO: checking WAL file name "000000010000000000000040"
INFO: checking WAL file name "000000010000000000000041"
INFO: checking WAL file name "000000010000000000000041.00000028.backup"
INFO: checking WAL file name "000000010000000000000042"

ARCHIVE INSTANCE 'node'
================================================================================================================================
 TLI  Parent TLI  Switchpoint  Min Segno                 Max Segno                 N segments  Size   Zratio  N backups  Status 
================================================================================================================================
 1    0           0/0          00000001000000000000001B  000000010000000000000042  40          640MB  1.00    5          OK     

Для каждой линии времени выдаются следующие сведения:

Чтобы получить более подробную информацию об архиве WAL в формате JSON, выполните команду:

pg_probackup show -B каталог_копий [--instance=имя_экземпляра] --archive --format=json

Пример вывода:

INFO: checking WAL file name "00000001000000000000001B"
INFO: checking WAL file name "00000001000000000000001C"
INFO: checking WAL file name "00000001000000000000001D"
INFO: checking WAL file name "00000001000000000000001E"
INFO: checking WAL file name "00000001000000000000001F"
INFO: checking WAL file name "000000010000000000000020"
INFO: checking WAL file name "000000010000000000000021"
INFO: checking WAL file name "000000010000000000000022"
INFO: checking WAL file name "000000010000000000000022.00000028.backup"
INFO: checking WAL file name "000000010000000000000023"
INFO: checking WAL file name "000000010000000000000024"
INFO: checking WAL file name "000000010000000000000025"
INFO: checking WAL file name "000000010000000000000026"
INFO: checking WAL file name "000000010000000000000027"
INFO: checking WAL file name "000000010000000000000028"
INFO: checking WAL file name "000000010000000000000029"
INFO: checking WAL file name "000000010000000000000029.00000028.backup"
INFO: checking WAL file name "00000001000000000000002A"
INFO: checking WAL file name "00000001000000000000002B"
INFO: checking WAL file name "00000001000000000000002C"
INFO: checking WAL file name "00000001000000000000002D"
INFO: checking WAL file name "00000001000000000000002E"
INFO: checking WAL file name "00000001000000000000002F"
INFO: checking WAL file name "000000010000000000000030"
INFO: checking WAL file name "000000010000000000000031"
INFO: checking WAL file name "000000010000000000000031.00000028.backup"
INFO: checking WAL file name "000000010000000000000032"
INFO: checking WAL file name "000000010000000000000033"
INFO: checking WAL file name "000000010000000000000034"
INFO: checking WAL file name "000000010000000000000035"
INFO: checking WAL file name "000000010000000000000036"
INFO: checking WAL file name "000000010000000000000037"
INFO: checking WAL file name "000000010000000000000038"
INFO: checking WAL file name "000000010000000000000039"
INFO: checking WAL file name "00000001000000000000003A"
INFO: checking WAL file name "00000001000000000000003B"
INFO: checking WAL file name "00000001000000000000003C"
INFO: checking WAL file name "00000001000000000000003C.00003020.backup"
INFO: checking WAL file name "00000001000000000000003D"
INFO: checking WAL file name "00000001000000000000003E"
INFO: checking WAL file name "00000001000000000000003F"
INFO: checking WAL file name "000000010000000000000040"
INFO: checking WAL file name "000000010000000000000041"
INFO: checking WAL file name "000000010000000000000041.00000028.backup"
INFO: checking WAL file name "000000010000000000000042"
[
    {
        "instance": "node",
        "timelines": [
            {
                "tli": 1,
                "parent-tli": 0,
                "switchpoint": "0/0",
                "min-segno": "00000001000000000000001B",
                "max-segno": "000000010000000000000042",
                "n-segments": 40,
                "size": 671088640,
                "zratio": 1.00,
                "closest-backup-id": "",
                "status": "OK",
                "lost-segments": [],
                "backups": [
                    {
                        "id": "SBOL94",
                        "status": "OK",
                        "start-time": "2024-04-09 18:19:52+03",
                        "backup-mode": "FULL",
                        "wal": "ARCHIVE",
                        "compress-alg": "lz4",
                        "compress-level": 1,
                        "from-replica": "false",
                        "block-size": 8192,
                        "xlog-block-size": 8192,
                        "checksum-version": 1,
                        "program-version": "2.7.3",
                        "server-version": "17",
                        "current-tli": 2,
                        "parent-tli": 0,
                        "start-lsn": "0/41000028",
                        "stop-lsn": "0/420000C0",
                        "end-time": "2024-04-09 18:19:58+03",
                        "end-validation-time": "2024-04-09 18:19:59+03",
                        "recovery-xid": 757,
                        "recovery-time": "2024-04-09 18:19:56.603355+03",
                        "data-bytes": 395651278,
                        "wal-bytes": 16777216,
                        "uncompressed-bytes": 578552566,
                        "pgdata-bytes": 578552248,
                        "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                        "content-crc": 3862224379
                    },
                    {
                        "id": "SBOL8S",
                        "status": "OK",
                        "start-time": "2024-04-09 18:19:40+03",
                        "parent-backup-id": "SBOL8G",
                        "backup-mode": "DELTA",
                        "wal": "STREAM",
                        "compress-alg": "lz4",
                        "compress-level": 1,
                        "from-replica": "false",
                        "block-size": 8192,
                        "xlog-block-size": 8192,
                        "checksum-version": 1,
                        "program-version": "2.7.3",
                        "server-version": "17",
                        "current-tli": 1,
                        "parent-tli": 1,
                        "start-lsn": "0/3C003020",
                        "stop-lsn": "0/3E8D4930",
                        "end-time": "2024-04-09 18:19:43+03",
                        "end-validation-time": "2024-04-09 18:19:44+03",
                        "recovery-xid": 757,
                        "recovery-time": "2024-04-09 18:19:43.707720+03",
                        "data-bytes": 119350434,
                        "wal-bytes": 67108864,
                        "uncompressed-bytes": 170044286,
                        "pgdata-bytes": 578552248,
                        "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                        "content-crc": 1259851036
                    },
                    {
                        "id": "SBOL8G",
                        "status": "OK",
                        "start-time": "2024-04-09 18:19:28+03",
                        "parent-backup-id": "SBOL83",
                        "backup-mode": "PTRACK",
                        "wal": "STREAM",
                        "compress-alg": "zlib",
                        "compress-level": 1,
                        "from-replica": "false",
                        "block-size": 8192,
                        "xlog-block-size": 8192,
                        "checksum-version": 1,
                        "program-version": "2.7.3",
                        "server-version": "17",
                        "current-tli": 1,
                        "parent-tli": 1,
                        "start-lsn": "0/31000028",
                        "stop-lsn": "0/310029E0",
                        "end-time": "2024-04-09 18:19:32+03",
                        "end-validation-time": "2024-04-09 18:19:33+03",
                        "recovery-xid": 756,
                        "recovery-time": "2024-04-09 18:19:32.594670+03",
                        "data-bytes": 31218302,
                        "wal-bytes": 16777216,
                        "uncompressed-bytes": 69610366,
                        "pgdata-bytes": 510263736,
                        "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                        "content-crc": 2293248595
                    },
                    {
                        "id": "SBOL83",
                        "status": "OK",
                        "start-time": "2024-04-09 18:19:15+03",
                        "parent-backup-id": "SBOL7P",
                        "backup-mode": "PAGE",
                        "wal": "STREAM",
                        "compress-alg": "pglz",
                        "compress-level": 1,
                        "from-replica": "false",
                        "block-size": 8192,
                        "xlog-block-size": 8192,
                        "checksum-version": 1,
                        "program-version": "2.7.3",
                        "server-version": "17",
                        "current-tli": 1,
                        "parent-tli": 1,
                        "start-lsn": "0/29000028",
                        "stop-lsn": "0/2A0000F8",
                        "end-time": "2024-04-09 18:19:22+03",
                        "end-validation-time": "2024-04-09 18:19:22+03",
                        "recovery-xid": 755,
                        "recovery-time": "2024-04-09 18:19:22.269595+03",
                        "data-bytes": 48394744,
                        "wal-bytes": 33554432,
                        "uncompressed-bytes": 69577598,
                        "pgdata-bytes": 441975224,
                        "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                        "content-crc": 343227200
                    },
                    {
                        "id": "SBOL7P",
                        "status": "OK",
                        "start-time": "2024-04-09 18:19:01+03",
                        "backup-mode": "FULL",
                        "wal": "STREAM",
                        "compress-alg": "zstd",
                        "compress-level": 1,
                        "from-replica": "false",
                        "block-size": 8192,
                        "xlog-block-size": 8192,
                        "checksum-version": 1,
                        "program-version": "2.7.3",
                        "server-version": "17",
                        "current-tli": 1,
                        "parent-tli": 0,
                        "start-lsn": "0/22000028",
                        "stop-lsn": "0/220001C8",
                        "end-time": "2024-04-09 18:19:07+03",
                        "end-validation-time": "2024-04-09 18:19:09+03",
                        "recovery-xid": 754,
                        "recovery-time": "2024-04-09 18:19:06.557301+03",
                        "data-bytes": 151177272,
                        "wal-bytes": 16777216,
                        "uncompressed-bytes": 373695222,
                        "pgdata-bytes": 373694904,
                        "primary_conninfo": "user=backup channel_binding=prefer host=localhost port=5432 sslmode=prefer sslcompression=0 sslcertmode=allow sslsni=1 ssl_min_protocol_version=TLSv1.2 gssencmode=prefer krbsrvname=postgres gssdelegation=0 target_session_attrs=any load_balance_hosts=disable",
                        "content-crc": 1636300818
                    }
                ]
            }
        ]
    }
]

В основном в этом формате представлены те же поля, что и в текстовом формате, с некоторыми исключениями:

Удаление ненужных копий #

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

Чтобы настроить политику хранения, задайте одну или несколько следующих переменных в файле pg_probackup.conf с помощью команды set-config:

--retention-redundancy=избыточность

Определяет количество полных резервных копий, которое должно сохраняться в каталоге копий.

--retention-window=окно

Определяет самый ранний момент времени, на который pg_probackup может выполнить восстановление. В этом параметре задаётся количество дней от текущего момента. Например, если retention-window=7, должна сохраниться минимум одна копия старее 7 дней, вместе с соответствующими файлами WAL и всеми последующими копиями.

Если установлены параметры --retention-redundancy и --retention-window, при очистке каталога от ненужных копий принимаются во внимание оба заданных ими условия. Например, если задать параметры --retention-redundancy=2 и --retention-window=7, программа pg_probackup должна сохранить две полные резервные копии, а также все копии, необходимые для восстановления данных, за последние семь дней:

pg_probackup set-config -B каталог_копий --instance=имя_экземпляра --retention-redundancy=2 --retention-window=7

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

Чтобы очистить каталог копий в соответствии с политикой хранения, нужно запустить команду delete с флагами сохранения, как показано ниже, или выполнить с этими флагами команду backup. В последнем случае ненужные копии будут удалены сразу после создания новой копии.

Например, чтобы удалить все резервные копии, считающиеся ненужными согласно установленной политике хранения, нужно выполнить следующую команду с флагом --delete-expired:

pg_probackup delete -B каталог_копий --instance=имя_экземпляра --delete-expired

Если вы хотите также удалить файлы WAL, которые больше не требуются ни для каких копий, укажите дополнительно --delete-wal:

pg_probackup delete -B каталог_копий --instance=имя_экземпляра --delete-expired --delete-wal

Вы также можете установить или переопределить текущую политику хранения, добавив параметры --retention-redundancy и --retention-window непосредственно при выполнении команд delete или backup:

pg_probackup delete -B каталог_копий --instance=имя_экземпляра --delete-expired --retention-window=7 --retention-redundancy=2

Так как для инкрементальных копий требуется наличие всех родительских полных копий и всех предыдущих инкрементальных копий, даже по истечении срока их хранения эти копии нельзя удалить, пока минимум одна инкрементальная копия в цепочке удовлетворяет политике хранения. Чтобы не хранить устаревшие копии, которые всё ещё нужны для восстановления нужной инкрементальной копии, вы можете объединить их с ней, воспользовавшись ключом --merge-expired команды backup или delete.

Предположим, что вы заархивировали экземпляр узла в каталог_копий со значением параметра --retention-window, равным 6, и значением параметра --retention-redundancy, равным 2, и на 1 августа 2024 г. у вас есть следующие копии:

BACKUP INSTANCE 'node'
===========================================================================================================================================
 Instance  Version  ID      Recovery Time           Mode   WAL Mode  TLI  Time    Data   WAL  Zalg  Zratio  Start LSN   Stop LSN    Status 
===========================================================================================================================================
 node      17       SHJ1N9  2024-08-01 09:50:00+03  FULL   ARCHIVE   1/0    5s    13MB  16MB  zstd    2,81  0/1D000028  0/1E0000C0  OK
 node      17       SHJ1N8  2024-08-01 09:49:59+03  DELTA  ARCHIVE   1/1    5s  6432kB  16MB  zstd    1,06  0/1A000028  0/1B0000C0  OK
 node      17       SHH6Z8  2024-07-31 09:49:59+03  PAGE   ARCHIVE   1/1    5s  6431kB  16MB  zstd    1,06  0/17000028  0/180000C0  OK
 node      17       SHFCB6  2024-07-30 09:49:57+03  FULL   ARCHIVE   1/0    5s    12MB  16MB  zstd    2,83  0/14000028  0/150000C0  OK
 node      17       SH9SB5  2024-07-27 09:49:56+03  PAGE   ARCHIVE   1/1    5s  6432kB  16MB  zstd    1,06  0/11000028  0/120000C0  OK
 ----------------------------------------------------------retention window-----------------------------------------------------------
 node      17       SH62Z5  2024-07-25 09:49:56+03  DELTA  ARCHIVE   1/1    5s  6431kB  16MB  zstd    1,06  0/E000028   0/F0000C0   OK
 node      17       SH48B3  2024-07-24 09:49:54+03  FULL   ARCHIVE   1/0    5s    12MB  16MB  zstd    2,86  0/B000028   0/C0000C0   OK
 node      17       SGWTN3  2024-07-20 09:49:54+03  PAGE   ARCHIVE   1/1    5s  6432kB  16MB  zstd    1,06  0/8000028   0/90000C0   OK
 node      17       SGUYZ2  2024-07-19 09:49:53+03  DELTA  ARCHIVE   1/1    5s  6442kB  16MB  zstd    1,07  0/5000028   0/60000C0   OK
 node      17       SGT4B1  2024-07-18 09:49:52+03  FULL   ARCHIVE   1/0    5s    11MB  16MB  zstd    2,89  0/2000028   0/3003A28   OK

При запуске команды delete с флагом --delete-expired резервные копии с идентификаторами SGT4B1, SGUYZ2 и SGWTN3 будут удалены как устаревшие по критериям окна хранения и избыточности (требуемый набор полных резервных копий уже сохранён). SGUYZ2 и SGWTN3 также будут удалены, поскольку базовая полная копия потеряла актуальность.

При запуске команды delete с флагом --merge-expired резервные копии SH48B3 и SH62Z5 будут объединены с SH9SB5. Объединение произойдёт именно с SH9SB5, так как это первая актуальная разностная копия, которую можно объединить с неактуальной разностной копией SH62Z5 и неактуальной полной копией SH48B3.

pg_probackup delete -B каталог_копий --instance=узел --delete-expired --merge-expired
pg_probackup show -B каталог_копий

BACKUP INSTANCE 'node'
===========================================================================================================================================
 Instance  Version  ID      Recovery Time           Mode   WAL Mode  TLI  Time    Data   WAL  Zalg  Zratio  Start LSN   Stop LSN    Status
===========================================================================================================================================
 node      17       SHJ1N9  2024-08-01 09:50:00+03  FULL   ARCHIVE   1/0    5s    13MB  16MB  zstd    2,81  0/1D000028  0/1E0000C0  OK
 node      17       SHJ1N8  2024-08-01 09:49:59+03  DELTA  ARCHIVE   1/1    5s  6432kB  16MB  zstd    1,06  0/1A000028  0/1B0000C0  OK
 node      17       SHH6Z8  2024-07-31 09:49:59+03  PAGE   ARCHIVE   1/1    5s  6431kB  16MB  zstd    1,06  0/17000028  0/180000C0  OK
 node      17       SHFCB6  2024-07-30 09:49:57+03  FULL   ARCHIVE   1/0    5s    12MB  16MB  zstd    2,83  0/14000028  0/150000C0  OK
 node      17       SH9SB5  2024-07-27 09:49:56+03  FULL   ARCHIVE   1/0    1s    12MB  16MB  zstd    2,84  0/11000028  0/120000C0  OK

Поле Time (Время) для объединённой копии показывает время, которое заняла процедура объединения.

Закрепление резервных копий #

Если вам нужно хранить отдельные копии дольше, чем допускает установленная политика хранения, вы можете дополнительно закрепить их на определённое время. Например:

pg_probackup set-backup -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии --ttl=30d

Эта команда задаёт срок хранения заданной резервной копии 30 дней, начиная с момента, указанного в атрибуте recovery-time этой копии.

Вы также можете явно задать время истечения срока хранения копии, воспользовавшись ключом --expire-time. Например:

pg_probackup set-backup -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии --expire-time="2027-04-09 18:21:32+00"

Также можно воспользоваться ключами --ttl и --expire-time команды backup и сразу закрепить создаваемую копию:

pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL --ttl=30d
pg_probackup backup -B каталог_копий --instance=имя_экземпляра -b FULL --expire-time="2027-04-09 18:21:32+00"

Определить, закреплена ли копия, можно с помощью команды show:

pg_probackup show -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии

Если копия закреплена, у неё есть атрибут expire-time, содержащий время окончания срока её хранения:

...
recovery-time = '2024-04-09 18:21:32+00'
expire-time = '2027-04-09 18:21:32+00'
data-bytes = 22288792
...

Отменить закрепление копии можно, передав в параметре --ttl ноль:

pg_probackup set-backup -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии --ttl=0

Настройка политики хранения архива WAL #

Когда осуществляется непрерывное архивирование WAL, сегменты WAL могут занимать много места на диске. Даже если вы время от времени удаляете старые резервные копии, с флагом --delete-wal могут быть удалены только те сегменты WAL, которые не относятся ни к какой копии из остающихся в каталоге. Однако если возможность восстановления на момент времени нужна только для последних копий, можно настроить политику хранения архива WAL, чтобы ограничить глубину архива и сэкономить место на диске.

Чтобы настроить политику хранения архива WAL, запустите команду set-config с параметром --wal-depth, задающим количество копий, которые могут быть использованы для PITR. Этот параметр действует для всех линий времени, поэтому вы сможете выполнять PITR для одинакового количества копий на каждой линии времени, при их наличии. Закреплённые копии в этом числе не учитываются: если закрепляется одна из последних копий, pg_probackup обеспечивает возможность PITR для каждой дополнительной копии.

Чтобы удалить сегменты WAL, не удовлетворяющие заданной политике хранения архива WAL, вы должны просто выполнить команду delete или backup с флагом --delete-wal. Для архивных копий сегменты WAL между Start LSN и Stop LSN всегда сохраняются, так что эти копии остаются рабочими вне зависимости от значения --wal-depth и при необходимости могут быть восстановлены.

Вы также можете использовать параметр --wal-depth с командами delete и backup для переопределения ранее заданной политики сохранения WAL и удаления старых сегментов WAL «на лету».

Предположим, что вы заархивировали экземпляр node в каталог_копий и настроили непрерывное архивирование WAL:

pg_probackup show -B каталог_копий --instance=узел

==================================================================================================================================================
 Instance  Version  ID      Recovery Time                  Mode   WAL Mode  TLI  Time    Data   WAL  Zalg  Zratio  Start LSN   Stop LSN    Status 
==================================================================================================================================================
 node      17       SBOLDA  2024-04-09 18:22:23.147138+03  DELTA  STREAM    1/1    1s  1165kB  16MB  zstd    1.09  0/6F000028  0/6F000190  OK     
 node      17       SBOLCY  2024-04-09 18:22:16.079841+03  FULL   STREAM    1/0   10s   278MB  16MB  zstd    2.46  0/6D000028  0/6D000190  OK     
 node      17       SBOLCW  2024-04-09 18:22:10.154022+03  DELTA  STREAM    1/1    2s  1364kB  16MB  zstd    1.01  0/6B000028  0/6B000190  OK     
 node      17       SBOLCS  2024-04-09 18:22:07.521646+03  DELTA  STREAM    1/1    4s    78MB  16MB  zstd    2.41  0/69000028  0/69000190  OK     
 node      17       SBOLCC  2024-04-09 18:21:55.830115+03  FULL   STREAM    1/0   15s   278MB  96MB  zstd    2.46  0/600060C8  0/64FE6640  OK     
 node      17       SBOLBW  2024-04-09 18:21:38.399702+03  FULL   STREAM    1/0   12s   278MB  96MB  zstd    2.46  0/54001830  0/589E5908  OK     

Вы можете проверить состояние архива WAL, запустив команду show с ключом --archive:

pg_probackup show -B каталог_копий --instance=node --archive

INFO: checking WAL file name "000000010000000000000052"
INFO: checking WAL file name "000000010000000000000053"
INFO: checking WAL file name "000000010000000000000054"
INFO: checking WAL file name "000000010000000000000054.00001830.backup"
INFO: checking WAL file name "000000010000000000000055"
INFO: checking WAL file name "000000010000000000000056"
INFO: checking WAL file name "000000010000000000000057"
INFO: checking WAL file name "000000010000000000000058"
INFO: checking WAL file name "000000010000000000000059"
INFO: checking WAL file name "00000001000000000000005A"
INFO: checking WAL file name "00000001000000000000005B"
INFO: checking WAL file name "00000001000000000000005C"
INFO: checking WAL file name "00000001000000000000005D"
INFO: checking WAL file name "00000001000000000000005E"
INFO: checking WAL file name "00000001000000000000005F"
INFO: checking WAL file name "000000010000000000000060"
INFO: checking WAL file name "000000010000000000000060.000060C8.backup"
INFO: checking WAL file name "000000010000000000000061"
INFO: checking WAL file name "000000010000000000000062"
INFO: checking WAL file name "000000010000000000000063"
INFO: checking WAL file name "000000010000000000000064"
INFO: checking WAL file name "000000010000000000000065"
INFO: checking WAL file name "000000010000000000000066"
INFO: checking WAL file name "000000010000000000000067"
INFO: checking WAL file name "000000010000000000000068"
INFO: checking WAL file name "000000010000000000000069"
INFO: checking WAL file name "000000010000000000000069.00000028.backup"
INFO: checking WAL file name "00000001000000000000006A"
INFO: checking WAL file name "00000001000000000000006B"
INFO: checking WAL file name "00000001000000000000006B.00000028.backup"
INFO: checking WAL file name "00000001000000000000006C"
INFO: checking WAL file name "00000001000000000000006D"
INFO: checking WAL file name "00000001000000000000006D.00000028.backup"
INFO: checking WAL file name "00000001000000000000006E"
INFO: checking WAL file name "00000001000000000000006F"
INFO: checking WAL file name "00000001000000000000006F.00000028.backup"

ARCHIVE INSTANCE 'node'
================================================================================================================================
 TLI  Parent TLI  Switchpoint  Min Segno                 Max Segno                 N segments  Size   Zratio  N backups  Status 
================================================================================================================================
 1    0           0/0          000000010000000000000052  00000001000000000000006F  30          480MB  1.00    6          OK     

Операция очистки WAL без ключа --wal-depth может удалить лишь один сегмент:

pg_probackup delete -B каталог_копий --instance=node --delete-wal

INFO: checking WAL file name "000000010000000000000054"
INFO: checking WAL file name "000000010000000000000054.00001830.backup"
INFO: checking WAL file name "000000010000000000000055"
INFO: checking WAL file name "000000010000000000000056"
INFO: checking WAL file name "000000010000000000000057"
INFO: checking WAL file name "000000010000000000000058"
INFO: checking WAL file name "000000010000000000000059"
INFO: checking WAL file name "00000001000000000000005A"
INFO: checking WAL file name "00000001000000000000005B"
INFO: checking WAL file name "00000001000000000000005C"
INFO: checking WAL file name "00000001000000000000005D"
INFO: checking WAL file name "00000001000000000000005E"
INFO: checking WAL file name "00000001000000000000005F"
INFO: checking WAL file name "000000010000000000000060"
INFO: checking WAL file name "000000010000000000000060.000060C8.backup"
INFO: checking WAL file name "000000010000000000000061"
INFO: checking WAL file name "000000010000000000000062"
INFO: checking WAL file name "000000010000000000000063"
INFO: checking WAL file name "000000010000000000000064"
INFO: checking WAL file name "000000010000000000000065"
INFO: checking WAL file name "000000010000000000000066"
INFO: checking WAL file name "000000010000000000000067"
INFO: checking WAL file name "000000010000000000000068"
INFO: checking WAL file name "000000010000000000000069"
INFO: checking WAL file name "000000010000000000000069.00000028.backup"
INFO: checking WAL file name "00000001000000000000006A"
INFO: checking WAL file name "00000001000000000000006B"
INFO: checking WAL file name "00000001000000000000006B.00000028.backup"
INFO: checking WAL file name "00000001000000000000006C"
INFO: checking WAL file name "00000001000000000000006D"
INFO: checking WAL file name "00000001000000000000006D.00000028.backup"
INFO: checking WAL file name "00000001000000000000006E"
INFO: checking WAL file name "00000001000000000000006F"
INFO: checking WAL file name "00000001000000000000006F.00000028.backup"

ARCHIVE INSTANCE 'node'
================================================================================================================================
 TLI  Parent TLI  Switchpoint  Min Segno                 Max Segno                 N segments  Size   Zratio  N backups  Status 
================================================================================================================================
 1    0           0/0          000000010000000000000054  00000001000000000000006F  28          448MB  1.00    6          OK     

Например, если вы хотите оставить только те сегменты, которые могут применяться к самой последней копии, передайте в параметре --wal-depth значение 1:

pg_probackup delete -B каталог_копий --instance=node --delete-wal --wal-depth=1

INFO: checking WAL file name "00000001000000000000006F"
INFO: checking WAL file name "00000001000000000000006F.00000028.backup"

ARCHIVE INSTANCE 'node'
===============================================================================================================================
 TLI  Parent TLI  Switchpoint  Min Segno                 Max Segno                 N segments  Size  Zratio  N backups  Status 
===============================================================================================================================
 1    0           0/0          00000001000000000000006F  00000001000000000000006F  1           16MB  1.00    6          OK     

Также вы можете использовать параметр --wal-depth с командой backup:

pg_probackup backup -B каталог_данных --instance=node -b DELTA --wal-depth=1 --delete-wal

INFO: checking WAL file name "000000010000000000000071"
INFO: checking WAL file name "000000010000000000000071.00000028.backup"

ARCHIVE INSTANCE 'node'
===============================================================================================================================
 TLI  Parent TLI  Switchpoint  Min Segno                 Max Segno                 N segments  Size  Zratio  N backups  Status 
===============================================================================================================================
 1    0           0/0          000000010000000000000071  000000010000000000000071  1           16MB  1.00    7          OK     

version #

pg_probackup version [--format=json]

Выводит версию и редакцию pg_probackup, а также версию и редакцию сервера Postgres Pro.

При указании --format=json вывод будет получен в формате JSON. Это может потребоваться для внутренней интеграции с приложениями на основе JSON, например PPEM. Пример вывода JSON:

pg_probackup version --format=json
{
"pg_probackup":
{
"version": "2.8.2",
"edition": "enterprise"
},
"database":
{
"type": "Postgres Pro Enterprise",
"version": "16.3.1"
},
"compressions": [zlib, pglz, lz4, zstd]
}

help #

pg_probackup help [команда]

Выдаёт справку по командам pg_probackup. Если в параметрах задаётся одна из команд pg_probackup, выводит подробную информацию по параметрам, которые принимает эта команда.

init #

pg_probackup init -B каталог_копий [--skip-if-exists] [параметры_s3] [--help]
[параметры_журнала]

Инициализирует каталог_копий, в котором будут храниться резервные копии, архив WAL и метаинформация о скопированных кластерах баз данных. Если заданный каталог_копий уже существует, он должен быть пустым. В противном случае pg_probackup выдаст соответствующее сообщение об ошибке. Вы можете отключить вывод этого сообщения, указав --skip-if-exists. Хотя каталог не будет инициализирован, приложение вернёт 0.

За подробностями обратитесь к подразделу Инициализация каталога копий.

add-instance #

pg_probackup add-instance -B каталог_копий -D каталог_данных --instance=имя_экземпляра
[--skip-if-exists] [параметры_s3] [--help] [параметры_журнала]

Инициализирует новый копируемый экземпляр в каталоге каталог_копий и создаёт файл конфигурации pg_probackup.conf, управляющий параметрами pg_probackup, относящимися к кластеру в указанном каталоге_данных. Если каталог уже был инициализирован, сообщение об ошибке можно отключить, указав --skip-if-exists.

За подробностями обратитесь к подразделу Определение копируемого экземпляра.

del-instance #

pg_probackup del-instance -B каталог_копий --instance=имя_экземпляра [параметры_s3][--help]
[параметры_журнала]

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

set-config #

pg_probackup set-config -B каталог_копий --instance=имя_экземпляра
[--help] [--pgdata=путь_к_pgdata]
[--retention-redundancy=избыточность][--retention-window=окно][--wal-depth=глубина_wal]
[--compress-algorithm=алгоритм_сжатия] [--compress-level=уровень_сжатия]
[-d имя_базы] [-h сервер] [-p порт] [-U имя_пользователя]
[--archive-timeout=тайм-аут] [--external-dirs=путь_внешнего_каталога]
[--restore-command=команда]
[параметры_удалённого_режима] [параметры_удалённого_архива_wal] [параметры_журнала] [параметры_s3]

Добавляет заданные параметры соединения, сжатия, хранения, ведения журнала и указания внешних каталогов в конфигурационный файл pg_probackup.conf либо изменяет ранее заданные значения.

Все поддерживаемые параметры описываются в подразделе Параметры.

Редактировать pg_probackup.conf вручную не рекомендуется.

set-backup #

pg_probackup set-backup -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии
{--ttl=время_жизни | --expire-time=время}
[--note=заметка_к_копии] [параметры_s3] [--help] [параметры_журнала]

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

Все поддерживаемые варианты закрепления описываются в подразделе Параметры закрепления.

show-config #

pg_probackup show-config -B каталог_копий --instance имя_экземпляра [--format=plain|json][параметры_s3]
[--no-scale-units][параметры_журнала]

Выводит все текущие параметры конфигурации pg_probackup, в том числе те, что содержатся в файле pg_probackup.conf, размещённом в каталоге каталог_копий/backups/имя_экземпляра. Вы можете добавить параметр --format=json для получения результата в формате JSON. По умолчанию параметры конфигурации выводятся обычным текстом.

Также можно добавить параметр --no-scale-units, чтобы выводить значения конфигурационных параметров времени и объёма памяти в единицах измерения по умолчанию. В противном случае эти значения преобразуются в более крупные единицы для более удобного отображения. Например, значение параметра archive-timeout 300 будет выводиться как 5min, а значение archive-timeout 301 — как 301s. Кроме того, с указанием --no-scale-units параметры конфигурации выводятся без единиц измерения, а значения формата JSON, а также числовые и логические значения не заключаются в кавычки, что упрощает разбор.

Чтобы изменить содержимое pg_probackup.conf, используйте команду set-config.

show #

pg_probackup show -B каталог_копий
[--help] [--instance=имя_экземпляра [-i ид_резервной_копии | --archive]] [--format=plain|json] [--no-color] [--show-symlinks] [параметры_s3]
[параметры_журнала]

Показывает содержимое каталога копий. Если задано имя_экземпляра и ид_резервной_копии, выводится подробная информация об этой копии. С указанием --archive эта команда показывает содержимое архива WAL в данном каталоге.

По умолчанию содержимое каталога представляется в виде обычного текста. Вы можете передать параметр --format=json, чтобы получить результат в формате JSON. С параметром --no-color выводимые сообщения не выделяются цветом.

Если указан параметр --show-symlinks, команда также показывает ссылки между объединяемыми резервными копиями и исходными полными копиями, с которыми были объединены инкрементальные копии.

Более подробно использование этой команды описывается в подразделах Управление каталогом резервных копий и Просмотр оглавления архива WAL.

backup #

pg_probackup backup -B каталог_копий -b режим_копирования --instance=имя_экземпляра
[--help] [-j число_потоков] [--progress]
[-C] [--stream [-S slot_name] [--temp-slot[=true|false|on|off]]] [--backup-pg-log]
[--no-validate] [--skip-block-validation]
[-w --no-password] [-W --password]
[--write-rate-limit=скорость_записи]
[--archive-timeout=тайм-аут] [--external-dirs=путь_внешнего_каталога]
[--no-sync] [--note=заметка_к_копии]
[параметры_соединения] [параметры_сжатия] [параметры_удалённого_режима]
[параметры_хранения] [параметры_закрепления] [параметры_журнала] [параметры_s3]

Создаёт резервную копию экземпляра Postgres Pro.

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

За подробностями обратитесь к подразделу Создание резервной копии.

restore #

pg_probackup restore -B каталог_копий --instance=имя_экземпляра
[--help] [--dry-run] [-D каталог_данных] [-i ид_резервной_копии]
[-j число_потоков] [--progress]
[-T СТАРЫЙ_КАТАЛОГ=НОВЫЙ_КАТАЛОГ] [--external-mapping=СТАРЫЙ_КАТАЛОГ=НОВЫЙ_КАТАЛОГ] [--skip-external-dirs]
[-R | --restore-as-replica] [--no-validate] [--skip-block-validation]
[--force] [--no-sync]
[--restore-command=команда]
[--primary-conninfo=строка_подключения]
[-S | --primary-slot-name=имя_слота]
[-X каталог_wal | --waldir=каталог_wal]
[параметры_точки_восстановления] [параметры_журнала] [параметры_удалённого_режима]
[параметры_частичного_восстановления] [параметры_удалённого_архива_wal] [параметры_s3]

Восстанавливает экземпляр Postgres Pro из резервной копии, расположенной в каталоге каталог_копий. Если вы укажете один или несколько параметров точки восстановления, pg_probackup найдёт ближайшую к этой точке копию и выполнит восстановление до заданной точки. Если ни идентификатор копии, ни параметры точки восстановления не задаются, pg_probackup выполняет восстановление, используя самую последнюю копию.

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

За подробностями обратитесь к подразделу Восстановление кластера.

checkdb #

pg_probackup checkdb
[-B каталог_копий] [--instance=имя_экземпляра] [-D каталог_данных]
[--help] [-j число_потоков] [--progress]
[--amcheck [--skip-block-validation] [--checkunique] [--heapallindexed]]
[параметры_соединения] [параметры_журнала]'
[параметры_s3]

Проверяет целостность кластера баз данных Postgres Pro, выявляя физические и логические повреждения.

При создании резервной копии экземпляра в хранилище S3 для корректной работы команды необходимо указать параметры S3 в командной строке или через переменные окружения.

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

За подробностями обратитесь к подразделу Проверка кластера.

validate #

pg_probackup validate -B каталог_копий
[--help] [--instance=имя_экземпляра] [-i ид_резервной_копии]
[-j число_потоков] [--progress] [--wal]
[--skip-block-validation]
[параметры_точки_восстановления] [параметры_журнала] [параметры_s3]

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

За подробностями обратитесь к подразделу Проверка копии.

merge #

pg_probackup merge -B каталог_копий --instance=имя_экземпляра -i ид_резервной_копии
[--dry-run] [--help] [-j число_потоков] [--progress] [--no-validate] [--no-sync]
[параметры_журнала]

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

За подробностями обратитесь к подразделам Общие параметры и Объединение резервных копий.

delete #

pg_probackup delete -B каталог_копий --instance=имя_экземпляра
[--help] [-j число_потоков] [--progress]
[--retention-redundancy=избыточность][--retention-window=окно][--wal-depth=глубина_wal] [--delete-wal]
{-i ид_резервной_копии | --delete-expired [--merge-expired] | --merge-expired | --status=backup_status}
[--dry-run] [--no-validate] [--no-sync] [параметры_журнала] [параметры_s3]

Удаляет копию с заданным идентификатором (ид_резервной_копии) или запускает процедуру удаления резервных копий или заархивированных файлов WAL, не удовлетворяющих текущей политике хранения.

За подробностями обратитесь к подразделам Удаление резервных копий, Параметры хранения и Настройка политики хранения.

archive-push #

pg_probackup archive-push -B каталог_копий --instance=имя_экземпляра
--wal-file-name=имя_файла_wal [--wal-file-path=путь_файлов_wal]
[--help] [--dry-run] [--no-sync] [--compress] [--no-ready-rename] [--overwrite]
[-j число_потоков] [--batch-size=размер_порции]
[--archive-timeout=тайм-аут]
[--compress-algorithm=алгоритм_сжатия]
[--compress-level=уровень_сжатия]
[параметры_удалённого_режима] [параметры_журнала] [параметры_s3]

Копирует файлы WAL в соответствующий подкаталог каталога копий, проверяя целевой экземпляр по имени_экземпляра и значению system-identifier. Если параметры экземпляра резервной копии и кластера не совпадают, операция копирования не выполняется, и выдаётся ошибка: Refuse to push WAL segment segment_name into archive. Instance parameters mismatch. (Отказано в помещении сегмента имя_сегмента в архив. Параметры экземпляра не совпадают.)

Если файлы, которые требуется копировать, уже имеются в каталоге копий, pg_probackup вычисляет и сравнивает их контрольные суммы. В случае совпадения контрольных сумм archive-push пропускает соответствующий файл и выдаёт код успешного завершения. Если же они не совпадают, операция archive-push завершается с ошибкой. Если вы хотите заменять существующие файлы WAL в случае несовпадения контрольных сумм, добавьте к команде archive-push ключ --overwrite.

Содержимое каждого файла копируется во временный файл с расширением .part. Если такой временный файл уже существует, pg_probackup ждёт, что он исчезнет в течение заданного параметром archive_timeout времени, а если этого не происходит, отбрасывает его. После переноса содержимого выполняется атомарная операция переименования. Тем самым гарантируется, что в случае ошибки команды archive-push непрерывное архивирование не остановится и что при параллельном архивировании WAL из разных источников в один архив повреждение архива исключено.

Postgres Pro запрашивает сегменты WAL по одному. Для ускорения архивирования вы можете воспользоваться параметром --batch-size, определяющим размер порции из нескольких копируемых сегментов WAL. Вместе с параметром --batch-size также можно применить указание -j, чтобы порции копировались в несколько потоков.

Сегменты WAL, копируемые в архив, по умолчанию (без указания флага --no-sync) гарантированно сбрасываются на диск.

Команду archive-push можно использовать в значении параметра archive_command Postgres Pro при настройке непрерывного архивирования WAL.

За подробностями обратитесь к подразделам Общие параметры, Параметры архивирования, Параметры сжатия и Параметры S3.

archive-get #

pg_probackup archive-get -B каталог_копий --instance=имя_экземпляра --wal-file-path=путь_файлов_wal --wal-file-name=имя_файла_wal
[-j число_потоков] [--batch-size=размер_порции]
[--prefetch-dir=каталог_предвыборки] [--no-validate-wal]
[--dry-run] [--help] [параметры_удалённого_режима] [параметры_журнала] [параметры_s3]

Копирует файлы WAL из соответствующего подкаталога каталога резервных копий в каталог журнала предзаписи кластера. Эта команда автоматически устанавливается программой pg_probackup в значении параметра restore_command при восстановлении архивных копий с применением архива WAL. Устанавливать её вручную не нужно, если вы используете для копий локальное хранилище или удалённый режим.

Если вы используете интерфейс S3, для обеспечения доступа сервера Postgres Pro к файлам WAL во время восстановления вы можете указать параметр --s3-config-file, определяющий файл конфигурации S3 с требуемыми параметрами конфигурации, как описано в Подразделе «Параметры S3».

Postgres Pro запрашивает сегменты WAL по одному. Для ускорения восстановления вы можете воспользоваться параметром --batch-size, определяющим размер порции из нескольких копируемых сегментов WAL. Вместе с параметром --batch-size также можно применить указание -j, чтобы порции сегментов копировались в несколько потоков.

За подробностями обратитесь к подразделам Общие параметры, Параметры архивирования, Параметры сжатия и Параметры S3.

catchup #

pg_probackup catchup -b режим_синхронизации
--source-pgdata=путь_к_копируемому_каталогу_данных
--destination-pgdata=путь_к_целевому_каталогу_данных
[--help] [-j | --threads=число_потоков] [--dry-run]
[--write-rate-limit=скорость_записи]
[--stream[--temp-slot[=true|false|on|off]] [-P | --perm-slot] [-S | --slot=имя_слота]
[--exclude-path=ПУТЬ]
[-T СТАРЫЙ_КАТАЛОГ=НОВЫЙ_КАТАЛОГ]
[-X | --waldir=каталог_wal]
[параметры_подключения] [параметры_удалённого_режима]
[параметры_журнала]

Создаёт копию экземпляра Postgres Pro, не используя каталог резервных копий.

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

За подробностями обратитесь к подразделу Клонирование и синхронизация экземпляра Postgres Pro.

Общие параметры #

Ниже приведён список параметров общего характера.

Параметры точки восстановления #

Если настроено непрерывное архивирование WAL, вы можете передать один из этих параметров с командой restore или validate, чтобы указать момент, до которого должен быть восстановлен или проверен кластер баз данных.

Параметры сохранения #

Эти параметры могут использоваться с командами backup и delete.

Подробнее о политике хранения рассказывается в подразделе Настройка политики хранения.

Параметры закрепления #

Эти параметры могут использоваться с командами backup и set-backup.

За подробностями обратитесь к подразделу Закрепление резервных копий.

Параметры ведения журнала #

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

Параметры подключения #

Эти параметры могут использоваться с командами backup, catchup и checkdb.

pg_probackup поддерживает все переменные окружения libpq.

Параметры сжатия #

Эти параметры могут использоваться с командами backup и archive-push.

Параметры архивации #

Эти параметры могут использоваться с командой archive-push в значении параметра archive_command и с командой archive-get в значении restore_command.

Дополнительно вы можете задать параметры удалённого сервера и ведения журнала.

Параметры удалённого режима #

В этом подразделе описываются параметры, связанные с удалённым выполнением операций pg_probackup по SSH. Эти параметры могут использоваться с командами add-instance, set-config, backup, catchup, restore, archive-push и archive-get.

Подробнее о настройке и использовании удалённого режима рассказывается в Подразделе «Настройка удалённого режима» и Подразделе «Использование pg_probackup в удалённом режиме».

Параметры удалённого архива WAL #

В этом подразделе описываются параметры, позволяющие задать аргументы archive-get для использования удалённого режима в команде restore_command при восстановлении PITR или восстановлении копий типа ARCHIVE.

Параметры инкрементального восстановления #

В этом подразделе описываются параметры, связанные с инкрементальным восстановлением кластера. Эти параметры могут передаваться с командой restore.

Параметры частичного восстановления #

В этом подразделе описываются параметры, связанные с частичным восстановлением кластера. Эти параметры могут передаваться с командой restore.

Параметры S3 #

В этом разделе описываются параметры, которые необходимо задать для размещения копий в частном облачном хранилище. Эти параметры могут задаваться с любыми командами, которые pg_probackup выполняет через интерфейс S3.

Параметры тестирования и отладки #

В этом подразделе описываются параметры, полезные лишь при тестировании или разработке.