命令参考 on PIG.CENTER

注解命令（annotate）

Mon, 01 Jan 0001 00:00:00 +0000

backup 命令执行时附加的注解，可在事后通过 annotate 命令进行添加、修改或删除。

命令选项

备份注解选项（`--annotation`）

为备份添加用户自定义键值对注解。

归档获取命令（archive-get）

Mon, 01 Jan 0001 00:00:00 +0000

PostgreSQL 通过此命令执行备份恢复、PITR，或将其作为流复制的替代方式来维持副本同步。WAL 段是 PostgreSQL 执行恢复或维护副本的必要条件。

配置多个仓库时，pgBackRest 按优先级顺序（如 repo1、repo2 等）依次从各仓库获取 WAL。速度更快或成本更低的存储应配置更高的优先级。若通过 --repo 选项指定了某个仓库，则仅从该仓库中查找。

归档推送命令（archive-push）

Mon, 01 Jan 0001 00:00:00 +0000

接收来自 PostgreSQL 的 WAL 段，并将其归档到各个仓库中（仓库路径由带索引的 repo-path 选项定义，详见 仓库选项 章节）。WAL 段可以立即推送到归档，也可以根据 archive-async 的值先暂存在本地。配置了多个仓库时，archive-push 会尽量向所有仓库推送。

备份命令（backup）

Mon, 01 Jan 0001 00:00:00 +0000

配置多个仓库时，pgBackRest 默认备份到优先级最高的仓库（如 repo1），除非通过 --repo 选项明确指定目标仓库。

pgBackRest 本身不内置调度器，建议通过 cron 或其他调度机制触发备份。

检查命令（check）

Mon, 01 Jan 0001 00:00:00 +0000

check 命令用于验证 pgBackRest 及 archive_command 的配置是否正确，确保指定 stanza（stanza 是 pgBackRest 中用于标识 PostgreSQL 集群备份配置的逻辑名称）的归档与备份能够正常运作。该命令会对当前主机上为该 stanza 配置的所有仓库和数据库逐一检查，可检测出配置错误——尤其是归档配置问题，此类问题会导致所需的 WAL 段无法进入归档，从而造成备份不完整。此命令可在 PostgreSQL 主机或仓库主机上运行；也可在备库主机上运行，但由于备库无法执行 pg_switch_xlog()/pg_switch_wal()，命令仅会测试仓库配置。

过期命令（expire）

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 基于保留策略对全量备份进行轮换，策略可按数量或时间段定义。按数量保留时，过期操作只关注需要保留的备份数量，不考虑备份的创建时间。差异备份按数量进行保留，但当其依赖的全量备份过期时，差异备份也会随之过期。增量备份没有独立的保留策略——它们始终随关联的全量备份或差异备份一同过期。详情及示例请参见 全量备份保留策略 和 差异备份保留策略 章节。

帮助命令（help）

Mon, 01 Jan 0001 00:00:00 +0000

help 命令提供三个层级的帮助信息：未指定命令时显示通用帮助；指定命令（例如 pgbackrest help backup）时显示该命令的完整说明及有效选项列表；在命令之外还指定了某个选项（例如 pgbackrest help backup type）时显示该选项在此命令下的完整说明。

Info 命令（info）

Mon, 01 Jan 0001 00:00:00 +0000

info 命令可查询单个 stanza（stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称）或所有 stanza 的信息。默认输出为文本格式，以人类可读的摘要展示所请求 stanza 的备份信息。该格式可能随版本更新而变化。

仓库获取命令（repo-get）

Mon, 01 Jan 0001 00:00:00 +0000

repo-get 命令类似于 Unix 的 cat 命令，但支持所有仓库类型。使用此命令需要提供完整的文件名，主要用于管理、排查和测试目的，不是常规 pgBackRest 使用流程中的必需命令。

若仓库已加密，repo-get 将自动解密文件。文件不会自动解压，但可将输出通过管道传递给相应的解压命令，例如 gzip -d。

仓库列表命令（repo-ls）

Mon, 01 Jan 0001 00:00:00 +0000

repo-ls 类似于 Unix 的 ls 命令，但支持所有 pgBackRest 仓库类型。该命令接受一个路径参数，可以是绝对路径，也可以是相对于 --repo-path 所定义的仓库根路径的相对路径。此命令主要用于管理、排查和测试场景，并非常规部署的必要命令。

恢复命令（restore）

Mon, 01 Jan 0001 00:00:00 +0000

restore 命令默认从第一个存有备份的仓库中自动选取最新备份（参见 快速开始 - 恢复备份 ）。仓库的检查顺序由 pgbackrest.conf 决定（例如先检查 repo1，再检查 repo2）。若要从特定仓库恢复，可使用 --repo 选项（例如 --repo=1）。若需恢复非最新的备份，可传入 --set 选项。

服务器命令（server）

Mon, 01 Jan 0001 00:00:00 +0000

pgBackRest 服务器允许在不使用 SSH 协议的情况下访问远程主机。

命令选项

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址。

服务器心跳命令（server-ping）

Mon, 01 Jan 0001 00:00:00 +0000

向 pgBackRest TLS 服务器发送 ping，确认其正在接受连接。此命令仅作为存活性检查，不进行身份验证。

若命令行中未指定主机，则使用 tls-server-host 选项的值。

命令选项

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址。

Stanza 创建命令（stanza-create）

Mon, 01 Jan 0001 00:00:00 +0000

stanza-create 命令须在 pgbackrest.conf 中完成 stanza 配置后再执行（stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称）。若配置了多个仓库，stanza-create 会在每个仓库上分别建立 stanza。已创建的 stanza 会被跳过，因此即便新增了仓库，也可以随时安全地重复执行 stanza-create。

Stanza 删除命令（stanza-delete）

Mon, 01 Jan 0001 00:00:00 +0000

stanza-delete 命令用于删除仓库中与指定 stanza 关联的所有数据。stanza 是 pgBackRest 中用于标识一个 PostgreSQL 集群备份配置的逻辑名称。

警告：

此命令会永久删除指定 stanza 在 pgBackRest 仓库中的所有备份和归档数据，请谨慎使用。

Stanza 升级命令（stanza-upgrade）

Mon, 01 Jan 0001 00:00:00 +0000

将 PostgreSQL 升级到新的主版本后，必须立即将所有 pgBackRest 配置中的 pg-path 更新为新的数据库位置，然后运行 stanza-upgrade 命令。若主机上配置了多个仓库，每个仓库都会执行 stanza 升级。若数据库处于离线状态，请使用 --no-online 选项。

启动命令（start）

Mon, 01 Jan 0001 00:00:00 +0000

如果 pgBackRest 进程之前已通过 stop 命令停止，可使用 start 命令重新允许它们运行。注意，此命令不会立即启动任何 pgBackRest 进程，只是解除运行限制。详情与示例请参见 启动与停止 。

通用选项

允许以 root 用户运行选项（`--allow-root`）

允许命令以 root 用户运行。

停止命令（stop）

Mon, 01 Jan 0001 00:00:00 +0000

禁止任何新的 pgBackRest 进程运行。默认情况下，正在运行的进程将被允许正常完成。使用 --force 选项可强制终止正在运行的进程。

stop 命令执行完成后，此后尝试运行的 pgBackRest 进程将返回错误。详情与示例请参见 启动与停止 。

验证命令（verify）

Mon, 01 Jan 0001 00:00:00 +0000

verify 用于验证仓库中的备份和归档是否有效。

命令选项

输出格式选项（`--output`）

输出类型。

支持以下输出类型：

版本命令（version）

Mon, 01 Jan 0001 00:00:00 +0000

显示已安装的 pgBackRest 版本。

命令选项

输出格式选项（`--output`）

输出类型。

支持以下输出类型：

text — 以文本形式显示已安装的 pgBackRest 版本。
num — 以整数形式显示已安装的 pgBackRest 版本。

default: text
example: --output=num

命令参考 on PIG.CENTER

注解命令（annotate）

命令选项

备份注解选项（--annotation）

归档获取命令（archive-get）

归档推送命令（archive-push）

备份命令（backup）

检查命令（check）

过期命令（expire）

帮助命令（help）

Info 命令（info）

仓库获取命令（repo-get）

仓库列表命令（repo-ls）

恢复命令（restore）

服务器命令（server）

命令选项

TLS 服务器地址选项（--tls-server-address）

服务器心跳命令（server-ping）

命令选项

TLS 服务器地址选项（--tls-server-address）

Stanza 创建命令（stanza-create）

Stanza 删除命令（stanza-delete）

Stanza 升级命令（stanza-upgrade）

启动命令（start）

通用选项

允许以 root 用户运行选项（--allow-root）

停止命令（stop）

验证命令（verify）

命令选项

输出格式选项（--output）

版本命令（version）

命令选项

输出格式选项（--output）

备份注解选项（`--annotation`）

TLS 服务器地址选项（`--tls-server-address`）

TLS 服务器地址选项（`--tls-server-address`）

允许以 root 用户运行选项（`--allow-root`）

输出格式选项（`--output`）

输出格式选项（`--output`）