设置要将输出写入的目标目录。pg_basebackup 将创建此目录（以及任何缺少的父目录），如果它不存在。如果它已经存在，则它必须为空。

当备份采用 tar 格式时，目标目录可以指定为 -（短横线），导致 tar 文件写入 stdout。

此选项是必需的。

选择输出的格式。格式 可以是以下之一

执行 增量备份。必须提供参考备份的备份清单，并将其上传到服务器，服务器将通过发送请求的增量备份进行响应。

创建 standby.signal 文件并将连接设置追加到目标目录中的 postgresql.auto.conf 文件（或在使用 tar 格式时追加到基本归档文件中）。这简化了使用备份结果设置备用服务器的过程。

postgresql.auto.conf 文件将记录连接设置，以及（如果指定）pg_basebackup 正在使用的复制槽，以便流式复制和 逻辑复制槽同步 稍后使用相同的设置。仅当在连接字符串或 环境变量 中显式指定了 dbname 时，才会记录 dbname。

指示服务器将基本备份放置在何处。默认目标为 client，它指定备份应发送到 pg_basebackup 正在运行的机器。如果目标设置为 server:/some/path，则备份将存储在服务器所在的机器上的 /some/path 目录中。将备份存储在服务器上需要超级用户权限或具有 pg_write_server_files 角色的权限。如果目标设置为 blackhole，则内容将被丢弃，不会存储在任何位置。这仅应用于测试目的，因为您最终不会获得实际的备份。

由于 WAL 流式传输是由 pg_basebackup 而不是服务器实现的，因此此选项不能与 -Xstream 一起使用。由于这是默认设置，因此当指定此选项时，还必须指定 -Xfetch 或 -Xnone。

在备份期间将目录 旧目录 中的表空间重新定位到 新目录。要生效，旧目录 必须与表空间在其上定义的源服务器上的路径规范完全匹配。（但如果源服务器上的 旧目录 中没有表空间，则不会出错。）同时，新目录 是接收主机文件系统中的一个目录。与主目标目录一样，新目录 无需事先存在，但如果它已存在，则它必须为空。 旧目录 和 新目录 都必须是绝对路径。如果任一路径需要包含等号 (=)，则在其前面加上反斜杠。此选项可以为多个表空间指定多次。

如果以这种方式重新定位了表空间，则主数据目录内的符号链接将更新为指向新位置。因此，新数据目录已准备好用于具有所有表空间更新位置的新服务器实例。

目前，此选项仅适用于普通输出格式；如果选择了 tar 格式，则会忽略它。

设置写入 WAL（预写日志）文件的目录。默认情况下，WAL 文件将放置在目标目录的 pg_wal 子目录中，但可以使用此选项将其放置在其他位置。waldir 必须是绝对路径。与主目标目录一样，waldir 不需要事先存在，但如果存在，则必须为空。此选项仅在备份采用纯格式时才能指定。

将所需的 WAL（预写日志）文件包含在备份中。这将包括在备份期间生成的全部预写日志。除非指定了方法 none，否则可以在目标目录中启动 postmaster 而无需查询 WAL 归档，从而使输出成为完全独立的备份。

支持以下用于收集预写日志的 method

启用 tar 文件输出的 gzip 压缩，使用默认压缩级别。压缩仅在使用 tar 格式时可用，并且后缀 .gz 将自动添加到所有 tar 文件名中。

请求备份压缩。如果包含 client 或 server，则指定在何处执行压缩。在服务器上压缩将减少传输带宽，但会增加服务器 CPU 消耗。默认值为 client，除非使用 --target。在这种情况下，备份不会发送到客户端，因此只有服务器压缩才是明智的。当使用 -Xstream（默认值）时，不会将服务器端压缩应用于 WAL。要压缩 WAL，请使用客户端压缩，或指定 -Xfetch。

压缩方法可以设置为 gzip、lz4、zstd、none（不压缩）或整数（如果为 0 则不压缩，如果大于 0 则为 gzip）。可以选择指定压缩详细信息字符串。如果详细信息字符串是整数，则指定压缩级别。否则，它应该是逗号分隔的项目列表，每个项目都采用 keyword 或 keyword=value 的形式。目前，支持的关键字是 level、long 和 workers。当压缩方法指定为普通整数时，不能使用详细信息字符串。

如果未指定压缩级别，则将使用默认压缩级别。如果仅指定了级别而未提及算法，则如果级别大于 0，则将使用 gzip 压缩，如果级别为 0，则不使用压缩。

当 tar 格式与 gzip、lz4 或 zstd 一起使用时，后缀 .gz、.lz4 或 .zst 将分别自动添加到所有 tar 文件名中。当使用纯格式时，可能不会指定客户端压缩，但仍然可以请求服务器端压缩。如果这样做，服务器将压缩备份以进行传输，客户端将解压缩并提取它。

当此选项与 -Xstream 结合使用时，如果选择了客户端 gzip 压缩，则 pg_wal.tar 将使用 gzip 压缩，但如果选择了任何其他压缩算法或选择了服务器端压缩，则不会压缩。

将检查点模式设置为快速（立即）或扩展（默认）（请参阅 第 25.3.4 节）。

指定在开始备份之前应创建由 --slot 选项命名的复制槽。如果槽已存在，则会引发错误。

设置备份的标签。如果未指定，则将使用默认值 “pg_basebackup base backup”。

默认情况下，当 pg_basebackup 中断并出现错误时，它会删除在发现无法完成作业之前可能已创建的任何目录（例如，目标目录和预写日志目录）。此选项抑制清理，因此对于调试很有用。

请注意，表空间目录无论如何都不会被清理。

默认情况下，pg_basebackup 将等待所有文件安全写入磁盘。此选项导致 pg_basebackup 返回而不等待，这更快，但意味着随后的操作系统崩溃可能会导致基本备份损坏。通常，此选项用于测试，但不应在创建生产安装时使用。

启用进度报告。启用此选项将在备份期间提供近似进度报告。由于数据库可能会在备份期间发生更改，因此这只是一个近似值，可能不会完全以 100% 结束。特别是，当 WAL 日志包含在备份中时，无法预先估计数据的总量，在这种情况下，一旦其超过不包含 WAL 的总估计值，估计的目标大小将增加。

设置从源服务器收集数据的最大传输速率。这对于限制 pg_basebackup 对服务器的影响很有用。值以千字节/秒为单位。使用后缀 M 表示兆字节/秒。也接受后缀 k，并且没有影响。有效值介于 32 千字节/秒和 1024 兆字节/秒之间。

此选项始终影响数据目录的传输。仅当收集方法为 fetch 时，WAL 文件的传输才会受到影响。

此选项只能与 -X stream 一起使用。它导致 WAL 流式传输使用指定的复制槽。如果基本备份旨在用作使用复制槽的流式复制备用服务器，则备用服务器应使用与 primary_slot_name 相同的复制槽名称。这可确保主服务器在基本备份结束和新备用服务器上的流式复制开始之间的时间内不会删除任何必要的 WAL 数据。

除非也使用选项 -C，否则指定的复制槽必须存在。

如果未指定此选项并且服务器支持临时复制槽（版本 10 及更高版本），则会自动使用临时复制槽进行 WAL 流式传输。

当设置为 fsync（默认值）时，pg_basebackup 将递归打开和同步备份目录中的所有文件。当使用纯格式时，文件搜索将遵循 WAL 目录和每个配置的表空间的符号链接。

在 Linux 上，可以使用 syncfs 来代替，以要求操作系统同步包含备份目录的整个文件系统。当使用纯格式时，pg_basebackup 也会同步包含 WAL 文件和每个表空间的文件系统。有关使用 syncfs 时需要注意的事项，请参阅 recovery_init_sync_method。

当使用 --no-sync 时，此选项无效。

启用详细模式。将在启动和关闭期间输出一些额外步骤，以及显示当前正在处理的确切文件名（如果也启用了进度报告）。

指定应应用于备份清单中包含的每个文件的校验和算法。目前，可用的算法有 NONE、CRC32C、SHA224、SHA256、SHA384 和 SHA512。默认值为 CRC32C。

如果选择 NONE，备份清单将不包含任何校验和。否则，它将使用指定的算法包含备份中每个文件的校验和。此外，清单始终包含其自身内容的 SHA256 校验和。SHA 算法比 CRC32C 算法更占用 CPU 资源，因此选择其中一个可能会增加完成备份所需的时间。

使用 SHA 哈希函数可以为希望验证备份未被篡改的用户提供每个文件的加密安全摘要，而 CRC32C 算法提供的校验和计算速度更快；它擅长捕获意外更改导致的错误，但不能抵抗恶意修改。请注意，为了对抗能够访问备份的攻击者，备份清单需要安全地存储在其他地方，或者以其他方式验证在备份完成之后未被修改。

pg_verifybackup 可用于根据备份清单检查备份的完整性。

强制备份清单中的所有文件名都进行十六进制编码。如果未指定此选项，则仅对非 UTF8 文件名进行十六进制编码。此选项主要用于测试读取备份清单文件的工具是否正确处理这种情况。

阻止服务器估算将要流式传输的备份数据的总量，导致 pg_stat_progress_basebackup 视图中的 backup_total 列始终为 NULL。

如果没有此选项，备份将首先枚举整个数据库的大小，然后返回并发送实际内容。这可能会使备份花费稍长时间，特别是它将在发送第一个数据之前花费更长时间。如果估计时间过长，此选项可用于避免此类估计时间。

使用 --progress 时不允许使用此选项。

禁用备份清单的生成。如果未指定此选项，服务器将生成并发送一个备份清单，可以使用 pg_verifybackup 进行验证。清单是备份中每个文件（可能包含的任何 WAL 文件除外）的列表。它还存储每个文件的大小、上次修改时间和可选的校验和。

阻止创建备份的临时复制槽。

默认情况下，如果选择了日志流式传输但没有使用 -S 选项提供槽名，则会创建一个临时复制槽（如果源服务器支持）。

此选项的主要目的是允许在服务器没有空闲复制槽时进行基本备份。使用复制槽几乎总是首选，因为它可以防止服务器在备份期间删除所需的 WAL。

禁用校验和的验证，如果在获取基本备份的服务器上启用了校验和。

默认情况下，会验证校验和，校验和失败将导致非零退出状态。但是，在这种情况下，基本备份不会被删除，就像使用了 --no-clean 选项一样。校验和验证失败也会在 pg_stat_database 视图中报告。

指定用于连接到服务器的参数，作为 连接字符串；这些将覆盖任何冲突的命令行选项。

为了与其他客户端应用程序保持一致，该选项称为 --dbname，但由于 pg_basebackup 不会连接到集群中的任何特定数据库，因此连接字符串中的任何数据库名称都将被 PostgreSQL 忽略。但是，用于连接到 PostgreSQL 的中间件或代理可能会利用该值。连接字符串中指定的数据库名称也可以被 逻辑复制槽同步 使用。

指定服务器所在的机器的主机名。如果该值以斜杠开头，则将其用作 Unix 域套接字的目录。默认值取自 PGHOST 环境变量（如果已设置），否则将尝试进行 Unix 域套接字连接。

指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。默认为 PGPORT 环境变量（如果已设置），或编译时默认值。

指定发送回源服务器的状态数据包之间的时间间隔（秒）。较小的值允许更准确地监控服务器上的备份进度。值为零将完全禁用定期状态更新，尽管在服务器请求时仍会发送更新，以避免基于超时的断开连接。默认值为 10 秒。

指定要连接的用户名称。

阻止发出密码提示。如果服务器需要密码身份验证并且密码无法通过其他方式（例如 .pgpass 文件）获得，则连接尝试将失败。此选项在没有用户在场输入密码的批处理作业和脚本中很有用。

强制 pg_basebackup 在连接到源服务器之前提示输入密码。

此选项绝非必需，因为如果服务器要求密码身份验证，pg_basebackup 会自动提示输入密码。但是，pg_basebackup 会浪费一次连接尝试来发现服务器需要密码。在某些情况下，值得键入 -W 以避免额外的连接尝试。

打印 pg_basebackup 版本并退出。

显示有关 pg_basebackup 命令行参数的帮助，并退出。