vb_probackup

功能描述

vb_probackup是一个用于管理VexDB数据库物理备份和恢复的工具。它可以对VexDB实例进行定期备份，以便在数据库出现故障时能够恢复服务器。

vb_probackup工具的主要功能如下：

• 备份：vb_probackup工具采用物理备份的方式进行备份，并且支持备份压缩。对数据库进行备份，可以增强数据库的抗风险能力。
  • 可用于备份单机数据库，也可对主机或者主节点数据库备机进行备份。
  • 可通过-E选项备份外部目录的内容，如脚本文件、配置文件、日志文件、dump文件、表空间等。
  • 支持全量备份、增量备份、备份合并、远程备份、通过定时任务脚本实现定期备份。
  • 除了基础的备份恢复操作以外，vb_probackup通过不同子命令实现了备份实例的管理、设置备份的留存策略等功能，全部用法详见命令说明。
  • 在进行全量备份前，若开启归档（即archive_mode设置为on）需要配置归档目录。
• 恢复：vb_probackup工具支持全量恢复与增量恢复，提供将数据库恢复到之前状态的能力。vb_probackup工具提供的恢复能力，是数据库安全可靠的重要保证。
• 验证：vb_probackup提供了验证备份完整性和一致性的功能，确保备份数据的可靠性。

以上介绍的主要功能，用户在使用时可以通过添加不同的参数，实现更准确的控制。

前提条件

• 可以正常连接VexDB数据库。
• 在配置文件postgresql.conf中手动设置参数enable_cbm_tracking为on，或通过vb_guc工具进行设置。
• 为了防止xlog在传输结束前被清理，请适当调高postgresql.conf文件中wal_keep_segments的值。

注意事项

• 备份必须由运行数据库服务器的操作系统用户执行。
• 备份和恢复的数据库服务器的主版本号必须相同。
• 在进行全量备份前，若开启归档（即archive_mode设置为on）需要配置归档目录。
• 如果要通过ssh在远程模式下备份数据库，需要在本地和远程主机安装相同主版本的数据库，并通过ssh-copy-id remote_user@remote_host命令设置本地主机备份用户和远程主机数据库用户的无密码ssh连接。
• 远程模式下只能执行add-instance、backup、restore子命令。
• 使用restore子命令前，应先停止数据库进程。
• 当存在用户自定义表空间时，备份时要加上-E或者--include-all参数，否则，该表空间不会被备份。
  外部表空间文件页面级别的增量备份，有助于减少备份文件占用的空间。
• 当存在用户自定义表空间时，如果该表空间的路径不在$PGDATA目录下，备份时需要将自定义表空间的绝对路径位置用 -E 指定，不然不会备份；恢复时需要使用--tablespace-mapping以及--external-mapping指示恢复映射。
• 当备份的规模比较大或在备份同时执行业务时，为了防止备份过程中timeout发生，请适当调整postgresql.conf文件的参数session_timeout、wal_sender_timeout。并且在备份的命令行参数中适当调整参数--rw-timeout的值。
• vb_probackup备份任务发生错误时，备份进程并不会完全退出，并且用vb_probackup show命令查看备份集状态时对应记录显示为ERROR，此时需要指定backup_id，手动删除状态为ERROR的备份集。
• vb_probackup不支持同时执行多个备份任务。
• 恢复时，使用-T选项把备份中的外部目录重定向到新目录时，请同时指定参数--external-mapping。
• 当使用远程备份时，请确保远程机器和备份机器的时钟同步，以防止使用--recovery-target-time恢复的场合，启动VexDB时有可能会失败。
• 当远程备份有效时(remote-proto=ssh)，请确保-h和--remote-host指定的是同一台机器。当远程备份无效时，如果指定了-h选项，请确保-h指定的是本机地址或本机主机名。
• 当前暂不支持备份逻辑复制槽。
• 增量备份恢复后，之前创建的逻辑复制槽不可用，需删除重建。
• 备份时，请确保服务器用户对备份的目录下所有文件有读写的权限，以防止在恢复时因权限不足的问题而失败。
• 备份将执行checkpoint与xlog switch操作，此行为将产生新的xlog，并提交事务。一主一备或一主多备场景备份时，若配置文件中synchronous_commit设置为on，备机关停可能会导致主机同步提交事务失败，进而导致备份失败。此场景下，请确认各节点状态正常，或将synchronous_commit设置为off以避免备份失败。
• 在开启enable_cbm_tracking后，不能直接执行增量备份，需要先执行全量备份，即使在开启参数之前已经执行过全量备份。
• 不支持跨CPU架构的远程备份。

命令说明

• init： 初始化备份路径backup-path中的备份目录，该目录将存储已备份的内容。backup-path必须为空目录。

  vb_probackup init -B backup-path [--help]
  

• add_instance： 在备份路径backup-path内初始化一个新的备份实例，并生成pg_probackup.conf配置文件，该文件保存了指定数据目录pgdata-path的vb_probackup设置。
  若未指定 -D 选项，则默认为数据库原始数据目录 $PGDATA。

  vb_probackup add-instance -B backup-path -D pgdata-path --instance=instance_name
              [-E external-directories-paths]
              [--remote-proto=protocol] [--remote-host=destination]
              [--remote-path=path] [--remote-user=username]
              [--remote-port=port] [--ssh-options=ssh_options]
              [--remote-libpath=libpath]
              [--enable-dss] [--instance-id=instance_id]
              [--vgname="vgdata,vglog"] [--socketpath=socketpath]
              [--help]
  

• del-instance： 在备份路径backup-path内删除指定实例相关的备份内容。

  vb_probackup del-instance -B backup-path --instance=instance_name
              [--help]
  

• set-config： 将指定的连接、压缩、日志等相关设置添加到pg_probackup.conf配置文件中，或修改已设置的值。不推荐手动编辑pg_probackup.conf配置文件。

  vbprobackup set-config -B backup-path --instance=instance_name
              [-D pgdata-path] [-E external-directories-paths]
              [--archive-timeout=timeout]
              [--retention-redundancy=retention-redundancy]
              [--retention-window=retention-window]
              [--wal-depth=wal-depth]
              [--compress-algorithm=compress-algorithm]
              [--compress-level=compress-level]
              [-d dbname] [-h host] [-p port] [-U username]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
              [--remote-proto=protocol] [--remote-host=destination]
              [--remote-path=path] [--remote-user=username]
              [--remote-port=port] [--ssh-options=ssh_options]
              [--remote-libpath=libpath]
              [--enable-dss] [--instance-id=instance_id]
              [--vgname="vgdata,vglog"] [--socketpath=socketpath]
              [--help]
  

• set-backup： 将备份相关设置添加到backup.control配置文件中，或修改已设置的值。

  vb_probackup set-backup -B backup-path --instance=instance_name -i backup-id
              [--note=text] [--ttl=interval] [--expire-time=time]
              [--help]
  

• show-config： 显示位于备份目录中的pg_probackup.conf配置文件的内容。可以通过指定--format=json选项，以json格式显示。默认情况下，显示为纯文本格式。

  vb_probackup show-config -B backup-path --instance=instance_name
              [--format=plain|json]
              [--help]
  

• show： 显示备份目录的内容。

  vb_probackup show -B backup-path
              [--instance=instance_name [-i backup-id]]
              [--archive] [--format=plain|json]
              [--do-enc]
              [--key-idx
              [--help]
  

  
  如果指定了instance_name和backup_id，则显示该备份的详细信息。可以通过指定--format=json选项，以json格式显示。默认情况下，备份目录的内容显示为纯文本格式。
  如果不指定instance_name和backup_id，则返回当前实例中的所有备份信息，每一条记录代表一个备份集。
• backup： 创建指定实例的备份。

  vb_probackup backup -B backup-path --instance=instance_name -b backup-mode
              [-D pgdata-path] [-C] [-S slot-name] [--temp-slot]
              [-s session-timeout]
              [--backup-pg-log] [-j threads_num] [--progress]
              [--no-validate] [--skip-block-validation]
              [-E external-directories-paths]
              [--no-sync] [--note=text]
              [--archive-timeout=timeout]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
              [--delete-expired] [--delete-wal] [--merge-expired]
              [--retention-redundancy=retention-redundancy]
              [--retention-window=retention-window]
              [--wal-depth=wal-depth] [--dry-run]
              [--compress-algorithm=compress-algorithm]
              [--compress-level=compress-level]
              [--compress]
              [-d dbname] [-h host] [-p port] [-U username] [-w] [-W password]
              [-t rwtimeout]
              [--remote-proto=protocol] [--remote-host=destination]
              [--remote-path=path] [--remote-user=username]
              [--remote-port=port] [--ssh-options=ssh_options]
              [--remote-libpath=libpath]
              [--stream]
              [--enable-dss] [--instance-id=instance_id]
              [--vgname="vgdata,vglog"] [--socketpath=socketpath]
              [--ttl=interval] [--expire-time=time]
              [--backup-pg-replslot]
              [--do-enc]
              [--key-idx
              [--help]
  

• restore： 从备份目录backup-path中的备份副本恢复指定实例。
  使用 restore 子命令前，应先停止 vexdb进程。
  如果指定了恢复目标相关参数，vb_probackup将查找最近的备份并将其还原到指定的恢复目标。否则，使用最近一次备份。

  vb_probackup restore -B backup-path --instance=instance_name
              [-D pgdata-path] [-i backup-id] [-j threads_num] [--progress]
              [--force] [--no-sync] [--no-validate] [--skip-block-validation]
              [--external-mapping=OLDDIR=NEWDIR] [-T OLDDIR=NEWDIR]
              [--skip-external-dirs] [-I incremental_mode]
              [--recovery-target-time=time|--recovery-target-xid=xid
              |--recovery-target-lsn=lsn|--recovery-target-name=target-name]
              [--recovery-target-inclusive=boolean]
              [--recovery-target=latest]
              [--remote-proto=protocol] [--remote-host=destination]
              [--remote-path=path] [--remote-user=username]
              [--remote-port=port] [--ssh-options=ssh_options]
              [--remote-libpath=libpath]
              [--enable-dss] [--instance-id=instance_id]
              [--vgname="vgdata,vglog"] [--socketpath=socketpath]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
              [--archive-host=hostname] [--archive-path=path]
              [--archive-port=port] [--archive-user=username]
              [--force-overwrite]
              [-K wal-directory]
              [--do-enc]
              [--key-idx
              [--help]
  

• merge： 将指定的增量备份与其父完全备份之间的所有增量备份合并到父完全备份。父完全备份将接收所有合并的数据，而已合并的增量备份将作为冗余被删除。

  vb_probackup merge -B backup-path --instance=instance_name -i backup-id
              [-j threads_num] [--progress]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
              [--do-enc]
              [--key-idx
              [--help]
  

• delete： 删除指定备份，或删除不满足当前保留策略的备份。

  vb_probackup delete -B backup-path --instance=instance_name
              [-i backup-id | --delete-expired | --merge-expired | --status=backup_status]
              [--delete-wal] [-j threads_num] [--progress]
              [--retention-redundancy=retention-redundancy]
              [--retention-window=retention-window]
              [--wal-depth=wal-depth] [--dry-run]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
              [--do-enc]
              [--key-idx
              [--help]
  

• validate： 验证恢复数据库所需的所有文件是否存在且未损坏。如果未指定instance_name，vb_probackup将验证备份目录中的所有可用备份。如果指定instance_name而不指定任何附加选项，vb_probackup将验证此备份实例的所有可用备份。如果指定了instance_name并且指定backup-id或恢复目标相关选项，vb_probackup将检查是否可以使用这些选项恢复数据库。

  vb_probackup validate -B backup-path
              [--instance=instance_name] [-i backup-id]
              [-j threads-num] [--progress] [--skip-block-validation]
              [--recovery-target-time=time|--recovery-target-xid=xid
              |--recovery-target-lsn=lsn|--recovery-target-name=target-name]
              [--recovery-target-inclusive=boolean]
              [--log-level-console=log-level-console]
              [--log-level-file=log-level-file]
              [--log-filename=log-filename]
              [--error-log-filename=error-log-filename]
              [--log-directory=log-directory]
              [--log-rotation-size=log-rotation-size]
              [--log-rotation-age=log-rotation-age]
  

• archive-push： 将WAL文件复制到备份目录的相应子目录中。

  vb_probackup archive-push -B backup-path --instance=instance_name
  --wal-file-path=wal-file-path
  --wal-file-name=wal-file-name
  [-j num-threads][--batch-size=batch_size]
  [--archive-timeout=timeout]
  [--no-ready-rename][--no-sync][--overwrite][--compress]
  [--compress-algorithm=compression-algorithm] [--compress-level=compression_level]
  [--remote-proto][--remote-host]
  [--remote-port][--remote-path][--remote-user]
  [--ssh-options]
  [--help]
  

• archive-get： 将WAL文件从备份目录对应的子目录复制到数据库的预写日志位置。
  进行restore时，vb_probackup会自动设置该命令作为restore_command的一部分，不需要手动设置；远程模式时，自动设置的archive-get命令不一定能直接使用，需要核对recovery.conf中的archive-get命令是否正确，可手动修改。

  vb_probackup archive-get -B backup-path --instance=instance_name
              --wal-file-path=wal-file-path
              --wal-file-name=wal-file-name
              [-j num-threads] [--batch-size=batch_size]
              [--no-validate-wal]
              [--remote-proto] [--remote-host]
              [--remote-port] [--remote-path] [--remote-user]
              [--ssh-options]
              [--do-enc]
              [--key-idx
              [--help]
  

• 其它功能
  打印vb_probackup版本。

  vb_probackup -V|--version
  vb_probackup version
  

  
  显示vb_probackup命令的摘要信息。如果指定了vb_probackup的子命令，则显示可用于此子命令的参数的详细信息。

  vb_probackup -?|--help
  vb_probackup help [command]
  

参数说明

通用参数

• command
  vb_probackup除version和help以外的子命令：init、add-instance、del-instance、set-config、set-backup、show-config、show、backup、restore、merge、delete、validate、archive-push、archive-get。
• -?, --help
  显示vb_probackup命令行参数的帮助信息，然后退出。子命令中只能使用--help，不能使用-?。
• -V, --version
  打印vb_probackup版本，然后退出。
• -B backup-path, --backup-path=backup-path
  备份的路径。
  系统环境变量：$BACKUP_PATH
• -D pgdata-path, --pgdata=pgdata-path
  数据目录的路径。
  系统环境变量：$PGDATA
• --instance=instance_name
  自定义的备份实例名。通过指定实例名，备份工具会根据元数据查到该实例的信息。
• -i backup-id, --backup-id=backup-id
  备份的唯一标识。
• --format=format
  指定显示备份信息的格式，支持plain和json格式。
  默认值：plain
• --status=backup_status
  删除指定状态的所有备份，包含以下状态：
  • OK：备份已完成且有效。
  • DONE：备份已完成但未经过验证。
  • RUNNING：备份正在进行中。
  • MERGING：备份正在合并中。
  • DELETING：备份正在删除中。
  • CORRUPT：部分备份文件已损坏。
  • ERROR：由于意外错误，备份失败。
  • ORPHAN：由于其父备份之一已损坏或丢失，备份无效。
• -j threads_num, --threads=threads_num
  设置备份、还原、合并进程的并行线程数。
• --archive
  显示WAL归档信息。
• --progress
  显示进度。
• --note=text
  给备份添加note。

备份相关参数

• -b backup-mode, --backup-mode=backup-mode
  指定备份模式，支持FULL、PTRACK和PTRACK_FROM_FULL。

  备份模式	备份内容	说明
  FULL	全量备份	全量备份包含所有数据文件。
  PTRACK	增量备份	仅备份自上次备份（可以是全量备份或者增量备份）以来发生变化的页/块。 PTRACK 模式下可以动态跟踪页面的更改。每次更新数据页时，都会在位图中进行相应的标记。
  PTRACK_FROM_FULL	差异备份	差异备份表示自最近一次全量备份以来的所有变化的数据页/块。

• -C, --smooth-checkpoint
  将检查点在一段时间内展开。默认情况下，vb_probackup会尝试尽快完成检查点。
• --stream
  从数据库服务器通过stream流处理形式传输文件，生成包括所有必需的WAL文件的STREAM备份。
  当前仅支持 stream 流处理形式，因此该参数可忽略。
• -S slot-name, --slot=slot-name
  指定WAL流处理的复制slot。
• --temp-slot
  在备份的实例中为WAL流处理创建一个临时物理复制slot，它确保在备份过程中，所有所需的WAL段仍然是可用的。
  默认的slot名为pg_probackup_slot，可通过选项--slot/-S更改。
• --backup-pg-log
  将日志目录包含到备份中。此目录通常包含日志消息。默认情况下包含日志目录，但不包含日志文件。如果修改了默认的日志路径，需要备份日志文件时可使用-E参数进行备份，使用方法见下文。
• -E external-directories-paths, --external-dirs=external-directories-paths
  该参数用于将用户指定的特定目录纳入到备份操作的范围之中。在实际应用场景中，当表空间、脚本文件、sql 转储文件以及配置文件存储于默认数据目录之外时，通过使用此选项，能够有效地将这些文件所在的目录备份。
  如果用户需要备份多个外部目录，可采用冒号（:）作为分隔符，依次列出各个目录的路径。例如，若有三个外部目录，其路径分别为 “/home/user/scripts”、“/var/backups/sql_dumps” 和 “/etc/config_files”，则在使用该参数时，应输入 “/home/user/scripts:/var/backups/sql_dumps:/etc/config_files”。
• --include-all
  备份包含所有外部表空间的数据。
  该选项可以与-E同时使用，程序会自动去除重复的外部表空间目录。
• --skip-block-validation
  关闭块级校验，加快备份速度。
• --no-validate
  在完成备份后跳过自动验证。
• --no-sync
  不将备份文件同步到磁盘。
• --note
  给备份添加note。
• --archive-timeout=timeout
  以秒为单位设置流式处理的超时时间。
  默认值：300
• -t rw-timeout
  以秒为单位的连接的超时时间。
  默认值: 120
• --backup-to-stdout
  将备份以流形式发送到STDOUT（标准输出），而不是直接将文件复制到备份目录。
  使用时需同时指定标准输出的位置（绝对路径或相对路径）。

  说明

  • 标准输入输出文件支持.bak、.sql、.txt、.tar.gz格式。
  • 流式备份不支持从备库备份。
  • 流式备份不支持通过MERGE命令合并全量和增量备份集。
  • 使用此模式进行增量备份时，其依赖的父备份需要通过标准输入传递。

恢复相关参数

• -I, --incremental-mode=none|checksum|lsn
  若PGDATA中可用的有效页没有修改，则重新使用它们，在增量恢复时，需手动指定该参数为checksum或lsn。
  默认值：none
• --external-mapping=OLDDIR=NEWDIR
  在恢复时，将包含在备份中的外部目录从_OLDDIR_重新定位到_NEWDIR_目录。_OLDDIR_和_NEWDIR_都必须是绝对路径。如果路径中包含“=”，则使用反斜杠转义。此选项可为多个目录多次指定。目前只支持指定文件系统中的目录，不支持指定共享存储中的目录。
• -T OLDDIR=NEWDIR, --tablespace-mapping=OLDDIR=NEWDIR
  在恢复时，将表空间从_OLDDIR_重新定位到_NEWDIR_目录。_OLDDIR_和_NEWDIR_必须都是绝对路径。如果路径中包含“=”，则使用反斜杠转义。多个表空间可以多次指定此选项。当-T参数值为外部表空间目录时，必须搭配--external-mapping参数使用。目前只支持指定文件系统中的目录，不支持指定共享存储中的目录。
• --skip-external-dirs
  跳过备份中包含的使用-external-dirs选项指定的外部目录。这些目录的内容将不会被恢复。
• --skip-block-validation
  跳过块级校验，以加快验证速度。在恢复之前的自动验证期间，将仅做文件级别的校验。
• --no-validate
  跳过备份验证。
• --force
  允许忽略备份的无效状态。如果出于某种原因需要从损坏的或无效的备份中恢复数据，可以使用此标志。请谨慎使用。
• --force-overwrite
  指定非空目录进行恢复。
• --restore-from-stdin
  从标准输入（STDIN）以流形式恢复数据。
  流式备份仅支持单线程恢复。
  恢复的目标目录必须为空或不存在。（此参数不能与--force-overwrite同时使用。）
• --reuse-old-dirs
  在恢复时重用外部表空间目录，无需通过--tablespace-mapping设置外部目录映射。
  • 未指定该选项时，备份文件中包含的所有外部表空间目录，都必须通过--external-mapping和--tablespace-mapping选项明确指定目录映射关系。如果存在未指定映射关系的外部表空间，或者备份集中指定的外部表空间不完整时，恢复过程会立即报错并终止。
  • 指定该选项时，恢复过程会忽略所有--external-mapping未提及的外部表空间，并重用原有的外部目录。
    只有确保备份文件创建后与恢复之间没有发生数据变更的外部表空间，才可以使用--reuse-old-dirs重用，否则会产生数据丢失，请谨慎使用。

恢复目标相关参数

说明

当前不支持配置连续的WAL归档的PITR，因而使用这些参数会有一定限制，具体如下描述。 如果需要使用持续归档的WAL日志进行PITR恢复，请按照下面描述的步骤：

1. 将物理备份的文件替换目标数据库目录。
2. 删除数据库目录下pg_xlog中的所有文件。
3. 将归档的WAL日志文件复制到pg_xlog文件中（此步骤可以省略，通过配置recovery.conf恢复命令文件中的restore_command项替代）。
4. 在数据库目录下创建恢复命令文件recovery.conf，指定数据库恢复的程度。
5. 启动数据库。
6. 连接数据库，查看是否恢复到希望预期的状态。若已经恢复到预期状态，通过pg_xlog_replay_resume()指令使主节点对外提供服务。

• --recovery-target-lsn=lsn
  指定要恢复到的lsn，当前只能指定备份的stop lsn。
• --recovery-target-name=target-name
  指定要将数据恢复到的已命名的保存点，保存点可以通过查看备份中recovery-name字段得到。
  当指定的恢复点不存在或者无效时，默认回放到最新日志的位置。
• --recovery-target-time=time
  指定要恢复到的时间，当前只能指定备份中的recovery-time。
• --recovery-target-xid=xid
  指定要恢复到的事务ID，当前只能指定备份中的recovery-xid。
• --recovery-target-inclusive=overwriteboolean
  当该参数指定为true时，恢复目标将包括指定的内容。当该参数指定为false时，恢复目标将不包括指定的内容。该参数必须和--recovery-target-name、--recovery-target-time、--recovery-target-lsn或--recovery-target-xid一起使用。
• --recovery-target=latest
  恢复未归档xlog。当数据库进程异常杀掉后导致xlog未归档时，指定latest自动恢复未归档的xlog。

留存相关参数

可以和backup/delete命令一起使用这些参数。

• --retention-redundancy=retention-redundancy
  指定在数据目录中留存的完整备份的数量。该参数必须设置为大于或等于 0 的整数。当设置为 0 时，表示禁用此留存策略，即不会依据该参数来限制留存的完整备份数量；若设置为 N（N 为大于 0 的整数），则意味着数据目录中会留存最近的 N 个完整备份。
  默认值：0
• --retention-window=retention-window
  指定留存的天数。必须为正整数。0表示禁用此设置。
  默认值：0
• --wal-depth=wal-depth
  用于控制 WAL 日志保留策略。该参数必须设置为大于或等于 0 的整数。当设置为 0 时，意味着不会额外保留备份链上的 WAL 日志；若设置为 N（N 为大于 0 的整数），则表示会保留每个备份链上，距离当前时间最近的 N 个有效备份所关联的 WAL 日志。
  此参数的作用在于，当执行删除旧备份的操作时，会确保保留与最近 N 个备份相关联的 WAL 日志。这些保留下来的 WAL 日志能够保证最近的这 N 个备份仍然可以用于时间点恢复（PITR，Point-In-Time Recovery）操作，即可以将数据库恢复到过去某个特定时间点的状态。
  默认值：0
• --delete-wal
  从任何现有的备份中删除不需要的WAL文件。
• --delete-expired
  删除不符合pg_probackup.conf配置文件中定义的留存策略的备份。
• --merge-expired
  将满足留存策略要求的最旧的增量备份与其已过期的父备份合并。
• --dry-run
  显示所有可用备份的当前状态，不删除或合并过期备份。

固定备份相关参数

• --ttl=interval
  指定从恢复时间开始计算，备份要固定的时间量。必须为正整数。0表示取消备份固定。支持的单位：ms、 s、 min、 h、 d（默认为s）。
  例如：--ttl=30d。
• --expire-time=time
  指定备份固定失效的时间戳。必须是ISO-8601标准的时间戳。需要和留存相关参数配合使用。
  例如：--expire-time='2020-01-01 00:00:00+03'
  如果要将某些备份从已建立的留存策略中排除，可以和backup/set-backup命令一起使用这些参数。

日志相关参数

日志级别：verbose、log、info、warning、error和off。

• --log-level-console=log-level-console
  设置要发送到控制台的日志级别。每个级别都包含其后的所有级别。级别越高，发送的消息越少。指定off级别表示禁用控制台日志记录。
  默认值：info
• --log-level-file=log-level-file
  设置要发送到日志文件的日志级别。每个级别都包含其后的所有级别。级别越高，发送的消息越少。指定off级别表示禁用日志文件记录。
  默认值：off
• --log-filename=log-filename
  指定要创建的日志文件的文件名。文件名可以使用strftime模式，因此可以使用%-escapes指定随时间变化的文件名。
  例如，如果指定了“pg_probackup-%u.log”模式，则pg_probackup为每周的每一天生成单独的日志文件，其中%u替换为相应的十进制数字，即pg_probackup-1.log表示星期一；pg_probackup-2.log表示星期二，以此类推。如果指定了--log-level-file参数启用日志文件记录，则该参数有效。
  默认值：“pg_probackup.log”
• --error-log-filename=error-log-filename
  指定仅用于error日志的日志文件名。指定方式与--log-filename参数相同。此参数用于故障排除和监视。
• --log-directory=log-directory
  指定创建日志文件的目录。必须是绝对路径。此目录会在写入第一条日志时创建。
  默认值：$BACKUP_PATH/log
• --log-rotation-size=log-rotation-size
  指定单个日志文件的最大大小。如果达到此值，则启动vb_probackup命令后，日志文件将循环，但help和version命令除外。0表示禁用基于文件大小的循环。支持的单位：KB、MB、GB、TB（默认为KB）。
  默认值：0
• --log-rotation-age=log-rotation-age
  单个日志文件的最大生命周期。如果达到此值，则启动vb_probackup命令后，日志文件将循环，但help和version命令$BACKUP_PATH/log/log_rotation目录下保存最后一次创建日志文件的时间。0表示禁用基于时间的循环。支持的单位：ms、 s、 min、 h、 d（默认为min）。
  默认值：0

连接相关参数

可以和backup命令一起使用这些参数。

• -d dbname, --pgdatabase=dbname
  指定要连接的数据库名称。该连接仅用于管理备份进程，因此您可以连接到任何现有的数据库。如果命令行、PGDATABASE环境变量或pg_probackup.conf配置文件中没有指定此参数，则vb_probackup会尝试从PGUSER环境变量中获取该值。如果未设置PGUSER变量，则从当前用户名获取。
  系统环境变量：$PGDATABASE
• -h hostname, --pghost=hostname
  指定运行服务器的系统的主机名。如果该值以斜杠开头，则被用作到Unix域套接字的路径。
  系统环境变量：$PGHOST
  默认值：local socket
• -p port, --pgport=_port
  指定服务器正在侦听连接的TCP端口或本地Unix域套接字文件扩展名。
  系统环境变量：$PGPORT
  默认值：5432
• -U username, --pguser=username
  指定所连接主机的用户名。
  系统环境变量：$PGUSER
• -w, --no-password
  不出现输入密码提示。如果主机要求密码认证并且密码没有通过其它形式给出，则连接尝试将会失败。 该选项在批量工作和不存在用户输入密码的脚本中很有帮助。
• -W, --password=password
  指定用户连接的密码。如果主机的认证策略是trust，则不会对系统管理员进行密码验证，即无需输入-W选项；如果没有-W选项，并且不是系统管理员，则会提示用户输入密码。

压缩相关参数

可以和backup命令一起使用这些参数。

• --compress-algorithm=compress-algorithm
  指定用于压缩数据文件的算法。
  取值包括zlib、pglz和none。如果设置为zlib或pglz，此选项将启用压缩。默认情况下，压缩功能处于关闭状态。
  当--compress-algorithm=zlib时，--compress-level参数取值不能为0。
  默认值：none
• --compress-level=compress-level
  指定压缩级别。该参数必须搭配--compress-algorithm一起使用，否则会报错。
  • 0表示无压缩。
  • 1表示压缩比最小，处理速度最快。
  • 9表示压缩比最大，处理速度最慢。
  
  可与--compress-algorithm选项一起使用。
  取值范围：0~9
  默认值：1
• --compress
  以--compress-algorithm=zlib和--compress-level=1进行压缩。

远程模式相关参数

• --remote-proto=protocol
  指定用于远程操作的协议。目前只支持SSH协议。取值包括：
  • ssh：通过SSH启用远程备份模式。这是默认值。
  • none：显式禁用远程模式。
  • 如果指定了--remote-host参数，可以省略此参数。
• --remote-host=destination
  指定要连接的远程主机的IP地址或主机名。
• --remote-port=port
  指定要连接的远程主机的端口号。
  默认值：22
• --remote-user=username
  指定SSH连接的远程主机用户。如果省略此参数，则使用当前发起SSH连接的用户。
  默认值：当前用户
• --remote-path=path
  指定vb_probackup在远程系统的安装目录。
  默认值：当前路径
• --remote-libpath=libpath
  指定vb_probackup在远程系统安装的lib库目录。
• --ssh-options=ssh_options
  指定SSH命令行参数的字符串。
  例如：--ssh-options='-c cipher_spec -F configfile'

归档相关参数

• --overwrite
  覆盖已归档的WAL文件。
• --batch-size=batch_size
  需要复制的文件总数。
• --prefetch-dir=path
  预取 WAL文件的存储目录。

备份流程

1. 初始化备份目录。在指定的目录下创建backups/和wal/子目录，分别用于存放备份文件和WAL文件。

   vb_probackup init -B backup-path
   

   
   虽然指定目录下会创建wal子目录，但WAL文件（即pg_xlog文件）会存放在backups目录下。
2. 添加一个新的备份实例。vb_probackup可以在同一个备份目录下存放多个数据库实例的备份。

   vb_probackup add-instance -B backup-path -D pgdata-path --instance instance_name
   

3. 编辑配置文档postgresql.conf，进行归档设置。（如果需要使用持续归档的WAL日志进行PITR恢复，则必须开启归档。）

   archive_mode = on
   archive_command='vb_probackup archive-push -B backup-path --instance instance-name --wal-file-path %p --wal-file-name %f [remote_options]' 
   hot_standby = on
   wal_level = hot_standby # 必须高于minimal
   

4. 创建指定实例的备份。在进行增量备份之前，必须至少创建一次全量备份。

   vb_probackup backup -B backup-path --instance instance_name -b backup_mode
   

5. 从指定实例的备份中恢复数据。在恢复备份时，必须先将原始实例目录（参数-D后面的目录）下面的内容清空。

   vb_probackup restore -B backup-path --instance instance_name -D pgdata-path -i backup_id
   

   说明

   • 在恢复备份前，必须先停止 vexdb进程，并且将原始实例目录（参数 -D 后面的目录）下面的内容清空。
   • 使用 restore 子命令前，应先停止 vexdb进程。
   • 如果因为网络临时故障等原因导致 server 端无应答，vb_probackup 将在等待 archive->timeout（默认300秒）后退出。

故障处理