Stanza 升级命令（stanza-upgrade）

原始页面： pgBackRest Command Docs: stanza-upgrade

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

命令选项

在线选项（--online）

在线更新集群。

指定 --no-online 可阻止 pgBackRest 在升级 stanza 时连接 PostgreSQL。

default: y
example: --no-online

通用选项

缓冲区大小选项（--buffer-size）

I/O 操作的缓冲区大小。

缓冲区大小用于复制、压缩、加密及其他操作。实际使用的缓冲区数量取决于各项选项，且每个操作可能会占用额外的内存，例如 gz 压缩最多可额外消耗 256KiB 内存。

允许的值为 16KiB、32KiB、64KiB、128KiB、256KiB、512KiB、1MiB、2MiB、4MiB、8MiB 和 16MiB。

default: 1MiB
example: --buffer-size=2MiB

SSH 客户端命令选项（--cmd-ssh）

SSH 客户端命令。

若需要使用特定的 SSH 客户端，或 ssh 命令不在 $PATH 中，可通过此选项指定。

default: ssh
example: --cmd-ssh=/usr/bin/ssh

网络压缩级别选项（--compress-level-network）

网络压缩级别。

当 compress-type=none 且命令不在仓库所在主机上运行时，设置网络传输的压缩级别。压缩用于降低网络流量。若 compress-type 不等于 none，则忽略 compress-level-network 设置，改用 compress-level，从而避免对文件进行二次压缩。

default: 1
allowed: [-5, 12]
example: --compress-level-network=1

配置文件选项（--config）

pgBackRest 配置文件。

通过此选项可指定与默认值不同的配置文件路径。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --config=/conf/pgbackrest/pgbackrest.conf

配置包含路径选项（--config-include-path）

pgBackRest 附加配置文件路径。

指定路径下扩展名为 .conf 的配置文件将与 pgBackRest 主配置文件合并，形成一个统一的配置文件。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --config-include-path=/conf/pgbackrest/conf.d

配置基础路径选项（--config-path）

pgBackRest 配置文件的基础路径。

此设置用于覆盖 --config 和 --config-include-path 选项的默认基础路径，除非这两个选项已在命令行中显式指定。

例如，仅传入 --config-path=/conf/pgbackrest 时，--config 的默认值将被设为 /conf/pgbackrest/pgbackrest.conf，--config-include-path 的默认值将被设为 /conf/pgbackrest/conf.d。

default: CFGOPTDEF_CONFIG_PATH
example: --config-path=/conf/pgbackrest

数据库超时选项（--db-timeout）

数据库查询超时时间。

设置对数据库执行查询操作的超时时间（单位：秒）。这包括备份启动/停止函数，这些函数各自可能耗时较长。因此，除非确认这些函数能快速返回（例如已设置 start-fast=y，且数据库集群在备份期间不会产生大量 WAL 段），否则应将超时时间设置得足够长。

注意： db-timeout 的值必须小于 protocol-timeout。

default: 30m
allowed: [100ms, 7d]
example: --db-timeout=600

I/O 超时选项（--io-timeout）

I/O 超时时间。

连接及读写操作的超时时间（单位：秒）。

注意，整个读写操作无需在此时间内完成，但必须持续有所进展，哪怕仅传输了一个字节。

default: 1m
allowed: [100ms, 1h]
example: --io-timeout=120

锁文件路径选项（--lock-path）

锁文件的存储路径。

pgBackRest 将锁文件存储在此路径下，以防止冲突操作并发运行。

default: /tmp/pgbackrest
example: --lock-path=/backup/db/lock

中性 umask 选项（--neutral-umask）

使用中性 umask。

将 umask 设置为 0000，使仓库中的文件以合理的权限创建。目录默认权限为 0750，文件默认权限为 0640。锁文件目录和日志目录的目录权限与文件权限分别为 0770 和 0660。

若要改用执行用户自身的 umask，请在配置文件中指定 neutral-umask=n，或在命令行中使用 --no-neutral-umask。

default: y
example: --no-neutral-umask

进程优先级选项（--priority）

进程优先级。

定义内核调度器赋予该进程的优先级（即 niceness 值）。正值降低优先级，负值提高优先级。大多数情况下，进程没有权限提高自身优先级。

allowed: [-20, 19]
example: --priority=19

协议超时选项（--protocol-timeout）

协议超时时间。

设置本地或远程进程在协议层等待接收新消息的超时时间（单位：秒）。此设置可防止进程无限期等待。

注意： protocol-timeout 的值必须大于 db-timeout。

default: 31m
allowed: [100ms, 7d]
example: --protocol-timeout=630

保活选项（--sck-keep-alive）

启用保活机制。

在套接字连接上启用保活消息。

default: y
example: --no-sck-keep-alive

Stanza 选项（--stanza）

定义 stanza。

stanza 是 PostgreSQL 数据库集群的配置单元，定义了集群的位置、备份方式、归档选项等信息。大多数数据库服务器只有一个 PostgreSQL 数据库集群，因此只有一个 stanza；而备份服务器通常会为每个需要备份的数据库集群分别配置一个 stanza。

命名 stanza 时，人们往往倾向于使用主集群名称，但更好的做法是根据集群所承载的数据库功能来命名。由于 stanza 名称会同时用于主库和所有副本，选择能描述集群实际功能的名称（如 app 或 dw）比使用本地集群名称（如 main 或 prod）更为合适。

example: --stanza=main

TCP 保活计数选项（--tcp-keep-alive-count）

保活计数。

指定在判定连接已断开之前，允许丢失的 TCP 保活消息数量。

此选项仅适用于支持 TCP_KEEPCNT 套接字选项的系统。

allowed: [1, 32]
example: --tcp-keep-alive-count=3

TCP 保活空闲时间选项（--tcp-keep-alive-idle）

保活空闲时间。

指定网络无活动后，操作系统发送 TCP 保活消息前的等待时间（单位：秒）。

此选项仅适用于支持 TCP_KEEPIDLE 套接字选项的系统。

allowed: [1, 3600]
example: --tcp-keep-alive-idle=60

TCP 保活间隔选项（--tcp-keep-alive-interval）

保活间隔时间。

指定未收到确认的 TCP 保活消息在重传前的等待时间（单位：秒）。

此选项仅适用于支持 TCP_KEEPINTVL 套接字选项的系统。

allowed: [1, 900]
example: --tcp-keep-alive-interval=30

TLSv1.2 加密套件选项（--tls-cipher-12）

允许使用的 TLSv1.2 加密套件。

pgBackRest 客户端与服务端之间的所有 TLS 连接均已加密。默认情况下，与对象存储（如 S3）的连接也会加密。

注意： 任何传输连接的最低安全级别要求为 TLSv1.2。

可根据需要调整所接受的加密套件。示例值是合理的选择，除非有特定的安全要求。若未设置（默认），则使用底层 OpenSSL 库的默认值。

example: --tls-cipher-12=HIGH:MEDIUM:+3DES:!aNULL

TLSv1.3 加密套件选项（--tls-cipher-13）

允许使用的 TLSv1.3 加密套件。

pgBackRest 客户端与服务端之间的所有 TLS 连接均已加密。默认情况下，与对象存储（如 S3）的连接也会加密。

注意： 任何传输连接的最低安全级别要求为 TLSv1.2。

可根据需要调整所接受的加密套件。若未设置（默认），则使用底层 OpenSSL 库的默认值。

example: --tls-cipher-13=TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256

日志选项

控制台日志级别选项（--log-level-console）

控制台日志级别。

支持以下日志级别：

• off - 不输出任何日志（不推荐）
• error - 仅记录错误
• warn - 记录警告和错误
• info - 记录信息、警告和错误
• detail - 记录详细信息、普通信息、警告和错误
• debug - 记录调试信息、详细信息、普通信息、警告和错误
• trace - 记录追踪信息（非常详细的调试输出）、调试信息、普通信息、警告和错误

default: warn
example: --log-level-console=error

文件日志级别选项（--log-level-file）

文件日志级别。

支持以下日志级别：

• off - 不输出任何日志（不推荐）
• error - 仅记录错误
• warn - 记录警告和错误
• info - 记录信息、警告和错误
• detail - 记录详细信息、普通信息、警告和错误
• debug - 记录调试信息、详细信息、普通信息、警告和错误
• trace - 记录追踪信息（非常详细的调试输出）、调试信息、普通信息、警告和错误

default: info
example: --log-level-file=debug

标准错误日志级别选项（--log-level-stderr）

stderr 日志级别。

指定哪些日志级别的输出将写入 stderr 而非 stdout（由 log-level-console 指定）。写入 stderr 的日志不包含时间戳和进程信息。

支持以下日志级别：

• off - 不输出任何日志（不推荐）
• error - 仅记录错误
• warn - 记录警告和错误
• info - 记录信息、警告和错误
• detail - 记录详细信息、普通信息、警告和错误
• debug - 记录调试信息、详细信息、普通信息、警告和错误
• trace - 记录追踪信息（非常详细的调试输出）、调试信息、普通信息、警告和错误

default: off
example: --log-level-stderr=error

日志路径选项（--log-path）

日志文件的存储路径。

pgBackRest 将日志文件存储在此路径下。注意，若 log-level-file=off，则无需配置日志路径。

default: /var/log/pgbackrest
example: --log-path=/backup/db/log

子进程日志选项（--log-subprocess）

启用子进程日志记录。

为当前进程创建的所有子进程启用文件日志，日志级别由 log-level-file 指定。

default: n
example: --log-subprocess

日志时间戳选项（--log-timestamp）

启用日志时间戳。

在控制台和文件日志中启用时间戳。在某些特殊场景（如生成文档）下，此选项会被禁用。

default: y
example: --no-log-timestamp

维护者选项

强制指定 PostgreSQL 版本选项（--pg-version-force）

强制指定 PostgreSQL 版本。

使用指定的 PostgreSQL 版本，而非通过读取 pg_control 或 WAL 头部自动检测到的版本。此选项主要用于 PostgreSQL 分支版本或开发版本，这些版本的控制文件版本号可能与正式发布版本不同。PostgreSQL 通过 server_version_num 报告的版本必须与强制指定的版本一致。

警告：

使用此选项时请务必谨慎，因为 pg_control 和 WAL 头部仍将按照指定版本所对应的官方 PostgreSQL 格式进行解析。若分支版本或开发版本修改了 pgBackRest 所依赖字段的格式，将导致不可预期的行为。通常情况下，此选项仅在分支版本将所有自定义结构成员追加在标准 PostgreSQL 成员之后时才能正常工作。

example: --pg-version-force=15

仓库选项

Azure 仓库容器选项（--repo-azure-container）

Azure 仓库容器。

用于存储仓库的 Azure 容器。

可通过设置 repo-path=/ 将 pgBackRest 仓库存储在容器根目录，但通常建议指定一个前缀路径（如 /repo），以便日志及其他 Azure 生成的内容也能存储在同一容器中。

example: --repo1-azure-container=pg-backup

Azure 仓库密钥类型选项（--repo-azure-key-type）

Azure 仓库密钥类型。

支持以下授权类型：

• shared - 共享密钥
• sas - 共享访问签名
• auto - 使用 Azure 托管标识自动授权

default: shared
example: --repo1-azure-key-type=sas

Azure 仓库 URI 风格选项（--repo-azure-uri-style）

Azure URI 风格。

支持以下 URI 风格：

• host - 连接到 account.endpoint 主机。
• path - 连接到 endpoint 主机，并在 URI 中添加账户名前缀。

default: host
example: --repo1-azure-uri-style=path

仓库加密类型选项（--repo-cipher-type）

仓库加密算法。

支持以下加密类型：

• none - 仓库不加密
• aes-256-cbc - 使用 256 位密钥的高级加密标准

注意，即使仓库类型（如 S3）本身支持加密，pgBackRest 的加密操作也始终在客户端执行。

default: none
example: --repo1-cipher-type=aes-256-cbc

GCS 仓库存储桶选项（--repo-gcs-bucket）

GCS 仓库存储桶。

用于存储仓库的 GCS 存储桶。

可通过设置 repo-path=/ 将 pgBackRest 仓库存储在存储桶根目录，但通常建议指定一个前缀路径（如 /repo），以便日志及其他 GCS 生成的内容也能存储在同一存储桶中。

example: --repo1-gcs-bucket=/pg-backup

GCS 仓库端点选项（--repo-gcs-endpoint）

GCS 仓库端点。

连接存储服务所使用的端点地址。可更新为本地 GCS 服务器或其他备用端点。

default: storage.googleapis.com
example: --repo1-gcs-endpoint=localhost

GCS 仓库密钥类型选项（--repo-gcs-key-type）

GCS 仓库密钥类型。

支持以下授权类型：

• auto - 使用实例服务账号授权。
• service - 使用本地存储的服务账号密钥。
• token - 用于本地测试，例如 fakegcs。

当 repo-gcs-key-type=service 时，认证令牌续期时将重新加载凭据。

default: service
example: --repo1-gcs-key-type=auto

GCS 仓库项目 ID 选项（--repo-gcs-user-project）

GCS 项目 ID。

用于确定请求计费方的 GCS 项目 ID。

example: --repo1-gcs-user-project=my-project

仓库主机选项（--repo-host）

远程操作时的仓库主机。

若备份和归档均写入本地挂载的文件系统，则无需此设置。

example: --repo1-host=repo1.domain.com

已弃用名称：backup-host

仓库主机证书颁发机构文件选项（--repo-host-ca-file）

仓库主机证书颁发机构文件。

使用非系统默认的 CA 文件连接仓库主机。

example: --repo1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

仓库主机证书颁发机构路径选项（--repo-host-ca-path）

仓库主机证书颁发机构路径。

使用非系统默认的 CA 路径连接仓库主机。

example: --repo1-host-ca-path=/etc/pki/tls/certs

仓库主机证书文件选项（--repo-host-cert-file）

仓库主机证书文件。

发送给仓库主机以证明客户端身份。

example: --repo1-host-cert-file=/path/to/client.crt

仓库主机命令选项（--repo-host-cmd）

仓库主机上的 pgBackRest 命令。

仅当本地主机与仓库主机上的 pgBackRest 命令路径不同时才需要配置。若未定义，仓库主机命令将与本地命令保持一致。

default: [path of executed pgbackrest binary]
example: --repo1-host-cmd=/usr/lib/backrest/bin/pgbackrest

已弃用名称：backup-cmd

仓库主机配置文件选项（--repo-host-config）

pgBackRest 仓库主机配置文件。

设置仓库主机上配置文件的路径。仅当仓库主机的配置文件路径与本地配置文件路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --repo1-host-config=/conf/pgbackrest/pgbackrest.conf

已弃用名称：backup-config

仓库主机配置包含路径选项（--repo-host-config-include-path）

pgBackRest 仓库主机配置包含路径。

设置仓库主机上配置包含路径的位置。仅当仓库主机的配置包含路径与本地配置包含路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --repo1-host-config-include-path=/conf/pgbackrest/conf.d

仓库主机配置路径选项（--repo-host-config-path）

pgBackRest 仓库主机配置路径。

设置仓库主机上配置路径的位置。仅当仓库主机的配置路径与本地配置路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH
example: --repo1-host-config-path=/conf/pgbackrest

仓库主机密钥文件选项（--repo-host-key-file）

仓库主机密钥文件。

用于证明客户端证书由其所有者发送。

example: --repo1-host-key-file=/path/to/client.key

仓库主机端口选项（--repo-host-port）

设置了 repo-host 时仓库主机使用的端口。

通过此选项为仓库主机协议指定非默认端口。

注意： 当 repo-host-type=ssh 时，repo-host-port 没有默认值，端口号由 cmd-ssh 指定的命令配置决定。

default (depending on repo-host-type):
   tls - 8432

allowed: [0, 65535]
example: --repo1-host-port=25

已弃用名称：backup-ssh-port

仓库主机协议类型选项（--repo-host-type）

仓库主机协议类型。

支持以下协议类型：

• ssh - 安全 Shell。
• tls - pgBackRest TLS 服务器。

default: ssh
example: --repo1-host-type=tls

仓库主机用户选项（--repo-host-user）

设置了 repo-host 时仓库主机使用的用户。

定义在仓库主机上执行操作所使用的用户。建议使用专用用户（如 pgbackrest），而非 postgres 用户。若 PostgreSQL 运行在仓库主机上，可将 postgres 用户加入 pgbackrest 组，使其拥有仓库的读权限，同时避免意外损坏仓库内容。

default: pgbackrest
example: --repo1-host-user=repo-user

已弃用名称：backup-user

仓库路径选项（--repo-path）

备份和归档的存储路径。

仓库是 pgBackRest 存储备份和归档 WAL 段的位置。

提前估算所需空间可能较为困难。建议先执行几次备份，记录不同类型备份（全量/增量/差异）的大小，并测量每日产生的 WAL 数据量，以此粗略估算所需空间。随着数据库规模增长，实际需求也会随之变化。

default: /var/lib/pgbackrest
example: --repo1-path=/backup/db/backrest

S3 仓库存储桶选项（--repo-s3-bucket）

S3 仓库存储桶。

用于存储仓库的 S3 存储桶。

可通过设置 repo-path=/ 将 pgBackRest 仓库存储在存储桶根目录，但通常建议指定一个前缀路径（如 /repo），以便日志及其他 AWS 生成的内容也能存储在同一存储桶中。

example: --repo1-s3-bucket=pg-backup

S3 仓库端点选项（--repo-s3-endpoint）

S3 仓库端点。

AWS 端点应与所选区域匹配。

对于自定义或测试配置，可使用 repo-storage-ca-file、repo-storage-ca-path、repo-storage-host、repo-storage-port 和 repo-storage-verify-tls 等选项。

example: --repo1-s3-endpoint=s3.amazonaws.com

S3 仓库密钥类型选项（--repo-s3-key-type）

S3 仓库密钥类型。

支持以下类型：

• shared - 共享密钥
• auto - 自动获取临时凭据
• web-id - 自动获取 Web 身份凭据

default: shared
example: --repo1-s3-key-type=auto

S3 仓库 KMS 密钥 ID 选项（--repo-s3-kms-key-id）

S3 仓库 KMS 密钥。

使用指定的 AWS 密钥管理服务密钥启用 S3 服务端加密。

example: --repo1-s3-kms-key-id=bceb4f13-6939-4be3-910d-df54dee817b7

S3 仓库区域选项（--repo-s3-region）

S3 仓库区域。

存储桶所在的 AWS 区域。

example: --repo1-s3-region=us-east-1

S3 仓库请求方付费选项（--repo-s3-requester-pays）

S3 仓库请求方付费。

启用 S3 请求方付费功能。

default: n
example: --no-repo1-s3-requester-pays

S3 仓库角色选项（--repo-s3-role）

S3 仓库角色。

当 repo-s3-key-type=auto 时，用于获取临时凭据的 AWS 角色名称（非完整 ARN）。

example: --repo1-s3-role=authrole

S3 仓库 URI 风格选项（--repo-s3-uri-style）

S3 URI 风格。

支持以下 URI 风格：

• host - 连接到 bucket.endpoint 主机。
• path - 连接到 endpoint 主机，并在 URI 中添加存储桶名前缀。

default: host
example: --repo1-s3-uri-style=path

SFTP 仓库主机选项（--repo-sftp-host）

SFTP 仓库主机。

存放仓库的 SFTP 主机。

example: --repo1-sftp-host=sftprepo.domain

SFTP 仓库主机指纹选项（--repo-sftp-host-fingerprint）

SFTP 仓库主机指纹。

SFTP 仓库主机指纹的生成方式应与 repo-sftp-host-key-hash-type 一致。可通过以下命令生成指纹：awk '{print $2}' ssh_host_xxx_key.pub | base64 -d | (md5sum or sha1sum) -b。SSH 主机密钥通常位于 /etc/ssh 目录下。

example: --repo1-sftp-host-fingerprint=f84e172dfead7aeeeae6c1fdfb5aa8cf

SFTP 主机密钥检查类型选项（--repo-sftp-host-key-check-type）

SFTP 主机密钥检查类型。

支持以下 SFTP 主机密钥检查类型：

• strict - pgBackRest 不会自动将主机密钥添加到 ~/.ssh/known_hosts 文件，并拒绝连接主机密钥已更改或不在已知主机文件中的主机。此选项要求用户手动添加所有新主机。
• accept-new - pgBackRest 会自动将新主机密钥添加到用户的已知主机文件，但不允许连接主机密钥已更改的主机。
• fingerprint - pgBackRest 将主机密钥与 repo-sftp-host-fingerprint 选项指定的指纹进行比对验证。
• none - 不执行主机密钥检查。

default: strict
example: --repo1-sftp-host-key-check-type=accept-new

SFTP 仓库主机密钥哈希类型选项（--repo-sftp-host-key-hash-type）

SFTP 仓库主机密钥哈希类型。

声明在 SSH 启动时用于计算远程系统主机密钥摘要的哈希算法。较新版本的 libssh2 除支持 md5 和 sha1 外，还支持 sha256。

example: --repo1-sftp-host-key-hash-type=sha256

SFTP 仓库主机端口选项（--repo-sftp-host-port）

SFTP 仓库主机端口。

default: 22
allowed: [1, 65535]
example: --repo1-sftp-host-port=22

SFTP 仓库主机用户选项（--repo-sftp-host-user）

SFTP 仓库主机用户。

存放仓库的主机上使用的用户。

example: --repo1-sftp-host-user=pg-backup

SFTP 已知主机文件选项（--repo-sftp-known-host）

SFTP 已知主机文件。

认证时用于搜索 SFTP 主机匹配的已知主机文件。若未指定，pgBackRest 默认搜索 ~/.ssh/known_hosts、~/.ssh/known_hosts2、/etc/ssh/ssh_known_hosts 和 /etc/ssh/ssh_known_hosts2。若配置了一个或多个文件路径，pgBackRest 将仅在这些文件中搜索匹配项。文件路径必须是完整路径或以波浪号开头的路径。此选项可多次指定以搜索多个已知主机文件。使用已知主机文件检查时，不得指定 repo-sftp-host-fingerprint。另请参阅 repo-sftp-host-check-type 选项。

example: --repo1-sftp-known-host=/home/postgres/.ssh/known_hosts

SFTP 仓库私钥文件选项（--repo-sftp-private-key-file）

SFTP 私钥文件。

用于认证的 SFTP 私钥文件。

example: --repo1-sftp-private-key-file=~/.ssh/id_ed25519

SFTP 仓库公钥文件选项（--repo-sftp-public-key-file）

SFTP 公钥文件。

用于认证的 SFTP 公钥文件。若编译时使用 OpenSSL，此项为可选；若使用其他库，则为必填项。

example: --repo1-sftp-public-key-file=~/.ssh/id_ed25519.pub

仓库存储 CA 文件选项（--repo-storage-ca-file）

仓库存储 CA 文件。

使用非系统默认的 CA 文件验证存储（如 S3、Azure）证书。

example: --repo1-storage-ca-file=/etc/pki/tls/certs/ca-bundle.crt

已弃用名称：repo-azure-ca-file, repo-s3-ca-file

仓库存储 TLS CA 路径选项（--repo-storage-ca-path）

仓库存储 CA 路径。

使用非系统默认的 CA 路径验证存储（如 S3、Azure）证书。

example: --repo1-storage-ca-path=/etc/pki/tls/certs

已弃用名称：repo-azure-ca-path, repo-s3-ca-path

仓库存储主机选项（--repo-storage-host）

仓库存储主机。

连接到存储（如 S3、Azure）端点以外的主机，通常用于测试场景。

example: --repo1-storage-host=127.0.0.1

已弃用名称：repo-azure-host, repo-s3-host

仓库存储端口选项（--repo-storage-port）

仓库存储端口。

连接存储（如 S3、Azure）端点（或指定主机）时使用的端口。

default: 443
allowed: [1, 65535]
example: --repo1-storage-port=9000

已弃用名称：repo-azure-port, repo-s3-port

仓库存储标签选项（--repo-storage-tag）

仓库存储标签。

指定在仓库为对象存储（如 S3）时添加到对象上的标签，可多次指定以添加多个标签。

pgBackRest 不提供修改这些标签的功能，因此请在运行 stanza-create 之前确认标签设置正确，以确保整个仓库的标签统一。

example: --repo1-storage-tag=key1=value1

仓库存储上传分块大小选项（--repo-storage-upload-chunk-size）

仓库存储上传分块大小。

S3 等对象存储在文件过大无法存入内存时，支持分块上传。即使文件可以存入内存，限制上传时的内存用量也能提高内存效率。

较大的分块大小通常能带来更好的性能，因为它可以减少上传请求次数，并允许更多文件在单次请求中完成上传而无需分块。缺点是内存占用更高，且由于分块缓冲区必须按进程分配，process-max 值越大，整体内存消耗越高。

注意，有效的分块大小因存储类型和平台而异。例如，AWS S3 的最小分块大小为 5MiB。各存储类型对分块大小的术语叫法不同：AWS S3 称为"part size"，GCS 称为"chunk size"，Azure 称为"block size"，查询最小/最大值时请注意使用对应术语。

若文件大于 1GiB（PostgreSQL 默认创建的最大文件大小），分块大小将逐步增大，直至达到允许的最大值，以完成文件上传。

default (depending on repo-type):
   azure - 4MiB
   gcs - 4MiB
   s3 - 5MiB

allow range (depending on repo-type):
   azure - [4MiB, 1GiB]
   gcs - [4MiB, 1GiB]
   s3 - [5MiB, 1GiB]

example: --repo1-storage-upload-chunk-size=16MiB

仓库存储证书验证选项（--repo-storage-verify-tls）

仓库存储证书验证。

控制是否验证存储（如 S3、Azure）服务器的 TLS 证书。仅在测试场景或使用自签名证书时才应禁用验证。

default: y
example: --no-repo1-storage-verify-tls

已弃用名称：repo-azure-verify-tls, repo-s3-verify-ssl, repo-s3-verify-tls

仓库类型选项（--repo-type）

仓库使用的存储类型。

支持以下仓库类型：

• azure - Azure Blob 存储服务
• cifs - 类似 posix，但禁用链接和目录 fsync
• gcs - Google 云存储
• posix - 符合 POSIX 标准的文件系统
• s3 - AWS 简单存储服务
• sftp - 安全文件传输协议

当使用 NFS 挂载作为 posix 类型仓库时，pgBackRest 适用与 PostgreSQL 文档中相同的规则，详见 Creating a Database Cluster - File Systems。

default: posix
example: --repo1-type=cifs

Stanza 选项

PostgreSQL 数据库选项（--pg-database）

PostgreSQL 数据库。

连接 PostgreSQL 时使用的数据库名称。默认值通常适用，但某些安装环境可能不包含此数据库。

注意，出于历史兼容性原因，PGDATABASE 环境变量的设置将被忽略。

default: postgres
example: --pg1-database=backupdb

PostgreSQL 主机选项（--pg-host）

远程操作时的 PostgreSQL 主机。

用于 PostgreSQL 主机与仓库主机不同时的备份场景。

example: --pg1-host=db.domain.com

已弃用名称：db-host

PostgreSQL 主机证书颁发机构文件选项（--pg-host-ca-file）

PostgreSQL 主机证书颁发机构文件。

使用非系统默认的 CA 文件连接 PostgreSQL 主机。

example: --pg1-host-ca-file=/etc/pki/tls/certs/ca-bundle.crt

PostgreSQL 主机证书颁发机构路径选项（--pg-host-ca-path）

PostgreSQL 主机证书颁发机构路径。

使用非系统默认的 CA 路径连接 PostgreSQL 主机。

example: --pg1-host-ca-path=/etc/pki/tls/certs

PostgreSQL 主机证书文件选项（--pg-host-cert-file）

PostgreSQL 主机证书文件。

发送给 PostgreSQL 主机以证明客户端身份。

example: --pg1-host-cert-file=/path/to/client.crt

PostgreSQL 主机命令选项（--pg-host-cmd）

PostgreSQL 主机上的 pgBackRest 命令。

仅当本地主机与 PostgreSQL 主机上的 pgBackRest 命令路径不同时才需要配置。若未定义，PostgreSQL 主机命令将与本地命令保持一致。

default: [path of executed pgbackrest binary]
example: --pg1-host-cmd=/usr/lib/backrest/bin/pgbackrest

已弃用名称：db-cmd

PostgreSQL 主机配置文件选项（--pg-host-config）

pgBackRest 数据库主机配置文件。

设置 PostgreSQL 主机上配置文件的路径。仅当 PostgreSQL 主机的配置文件路径与本地配置文件路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_FILE
example: --pg1-host-config=/conf/pgbackrest/pgbackrest.conf

已弃用名称：db-config

PostgreSQL 主机配置包含路径选项（--pg-host-config-include-path）

pgBackRest 数据库主机配置包含路径。

设置 PostgreSQL 主机上配置包含路径的位置。仅当 PostgreSQL 主机的配置包含路径与本地配置包含路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH "/" PROJECT_CONFIG_INCLUDE_PATH
example: --pg1-host-config-include-path=/conf/pgbackrest/conf.d

PostgreSQL 主机配置路径选项（--pg-host-config-path）

pgBackRest 数据库主机配置路径。

设置 PostgreSQL 主机上配置路径的位置。仅当 PostgreSQL 主机的配置路径与本地配置路径不同时才需要配置。

default: CFGOPTDEF_CONFIG_PATH
example: --pg1-host-config-path=/conf/pgbackrest

PostgreSQL 主机密钥文件选项（--pg-host-key-file）

PostgreSQL 主机密钥文件。

用于证明客户端证书由其所有者发送。

example: --pg1-host-key-file=/path/to/client.key

PostgreSQL 主机端口选项（--pg-host-port）

设置了 pg-host 时 PostgreSQL 主机使用的端口。

通过此选项为 PostgreSQL 主机协议指定非默认端口。

注意： 当 pg-host-type=ssh 时，pg-host-port 没有默认值，端口号由 cmd-ssh 指定的命令配置决定。

default (depending on pg-host-type):
   tls - 8432

allowed: [0, 65535]
example: --pg1-host-port=25

已弃用名称：db-ssh-port

PostgreSQL 主机协议类型选项（--pg-host-type）

PostgreSQL 主机协议类型。

支持以下协议类型：

• ssh - 安全 Shell。
• tls - pgBackRest TLS 服务器。

default: ssh
example: --pg1-host-type=tls

PostgreSQL 主机用户选项（--pg-host-user）

设置了 pg-host 时 PostgreSQL 主机的登录用户。

该用户同时也是远程 pgBackRest 进程的所有者，并负责发起与 PostgreSQL 的连接。为确保正常工作，此用户应是 PostgreSQL 数据库集群的所有者，通常为 postgres（默认值）。

default: postgres
example: --pg1-host-user=db_owner

已弃用名称：db-user

PostgreSQL 路径选项（--pg-path）

PostgreSQL 数据目录。

此路径应与 PostgreSQL 报告的 data_directory 一致。尽管可以从多处读取该值，但建议显式配置，以防在恢复或离线备份场景中这些资源不可用。

pg-path 选项在每次在线备份时都会与 PostgreSQL 报告的值进行校验，因此应始终保持最新。

example: --pg1-path=/data/db

已弃用名称：db-path

PostgreSQL 端口选项（--pg-port）

PostgreSQL 端口。

PostgreSQL 运行的端口号。大多数 PostgreSQL 集群使用默认端口，通常无需指定此项。

default: 5432
allowed: [0, 65535]
example: --pg1-port=6543

已弃用名称：db-port

PostgreSQL Socket 路径选项（--pg-socket-path）

PostgreSQL Unix Socket 路径。

PostgreSQL 启动时指定的 Unix Socket 目录。pgBackRest 会自动查找操作系统的标准位置，通常无需配置此项，除非通过 postgresql.conf 中的 unix_socket_directories 显式修改了 Socket 目录。

example: --pg1-socket-path=/var/run/postgresql

已弃用名称：db-socket-path

PostgreSQL 数据库用户选项（--pg-user）

PostgreSQL 数据库用户。

连接 PostgreSQL 时使用的数据库用户名。若未指定，pgBackRest 将使用本地操作系统用户或 PGUSER 环境变量。

example: --pg1-user=backupuser