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

当备份以tar格式保存时，目标目录可以指定为-（破折号），导致tar文件被写入stdout。

这个选项是必需的。

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

创建一个standby.signal 文件， 并将连接设置附加到postgresql.auto.conf文件中的目标目录（或在使用tar格式时在基本归档文件中）。这样可以使用备份的结果轻松设置一个备用服务器。

postgresql.auto.conf文件将记录连接设置，以及如果指定的话，pg_basebackup正在使用的复制槽， 以便后续流复制将使用相同的设置。

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

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

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

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

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

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

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

支持以下用于收集预写式日志的方法：

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

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

压缩方法可以设置为gzip、lz4、zstd或none以进行无压缩。 可以选择性地指定压缩详细信息字符串。如果详细信息字符串是一个整数，则它指定了压缩级别。 否则，它应该是一个逗号分隔的项目列表，每个项目的形式为keyword或keyword=value。 目前，支持的关键字是level和workers。

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

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

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

将检查点模式设置为快速（即时）或扩散（默认） （参见第 26.3.3 节）。

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

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

默认情况下，当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流式传输。

启用详细模式。在启动和关闭过程中输出一些额外步骤，以及在启用进度报告的情况下显示当前正在处理的确切文件名。

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

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

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

pg_verifybackup可以用来检查备份与备份清单的完整性。

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

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

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

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

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

防止为备份创建临时复制插槽。

默认情况下，如果选择了日志流但没有使用-S选项指定槽名， 那么将创建一个临时复制槽（如果源服务器支持）。

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

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

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

指定用于连接到服务器的参数，比如连接字符串；这些将覆盖所有冲突的命令行选项。

为了和其他客户端应用一致，该选项被称为--dbname。但是因为pg_basebackup并不连接到集簇中的任何特定数据库，连接字符串中的任何数据库名将被忽略。

指定运行服务器的机器的主机名。如果该值以一个斜线开始，它被用作 Unix 域套接字的目录。默认值取自PGHOST环境变量（如果设置），否则会尝试一个 Unix 域套接字连接。

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

指定发送回源服务器的状态包之间的秒数。较小的值可以更准确地监视服务器的备份进度。一个零值完全禁用这种周期性的状态更新，不过当服务器需要时还是会有一个更新会被发送来避免超时导致的断开连接。默认值是 10 秒。

指定连接的用户名。

防止发出口令提示。如果服务器要求口令认证并且没有其他方式提供口令（例如一个.pgpass文件），那儿连接尝试将失败。这个选项对于批处理任务和脚本有用，因为在其中没有一个用户来输入口令。

强制pg_basebackup在连接到源服务器之前提示要求一个口令。

这个选项不是必不可少的，因为如果服务器要求口令认证，pg_basebackup将自动提示要求一个口令。但是，pg_basebackup将浪费一次连接尝试来发现服务器想要一个口令。在某些情况下值得用-W来避免额外的连接尝试。

打印pg_basebackup版本并退出。

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