pg_receivewal — 从 PostgreSQL 服务器流式传输预写日志
pg_receivewal [选项...]
pg_receivewal 用于从运行的 PostgreSQL 集群流式传输预写日志。预写日志使用流式复制协议进行流式传输，并写入本地文件目录。该目录可用作进行使用时间点恢复的恢复的归档位置（参见 第 25.3 节）。
pg_receivewal 实时流式传输预写日志，因为它是在服务器上生成的，并且不像 archive_command 和 archive_library 那样等待段完成。因此，在使用 pg_receivewal 时，无需设置 archive_timeout。
与 PostgreSQL 备用服务器的 WAL 接收器不同，pg_receivewal 默认情况下仅在 WAL 文件关闭时刷新 WAL 数据。必须指定选项 --synchronous 才能实时刷新 WAL 数据。由于 pg_receivewal 不应用 WAL，因此当 synchronous_commit 等于 remote_apply 时，不应允许它成为同步备用。如果它确实如此，它将看起来像一个永远无法赶上的备用，并导致事务提交阻塞。为了避免这种情况，您应该为 synchronous_standby_names 配置一个适当的值，或者为 pg_receivewal 指定不匹配它的 application_name，或者将 synchronous_commit 的值更改为 remote_apply 以外的其他值。
预写日志通过常规 PostgreSQL 连接进行流式传输，并使用复制协议。连接必须使用具有 REPLICATION 权限的用户（参见 第 21.2 节）或超级用户建立，并且 pg_hba.conf 必须允许复制连接。服务器还必须配置 max_wal_senders 设置为足够高的值，以便至少为流保留一个会话可用。
预写日志流式传输的起点是在 pg_receivewal 启动时计算的。
首先，扫描写入 WAL 段文件的目录并找到最新的已完成的段文件，使用下一个 WAL 段文件的开头作为起点。
如果使用复制槽，并且无法使用之前的方法计算起点，则会发出一个额外的 READ_REPLICATION_SLOT 命令来检索槽的 restart_lsn 用作起点。此选项仅在从 PostgreSQL 15 及更高版本流式传输预写日志时可用。
如果无法使用之前的方法计算起点，则使用服务器从 IDENTIFY_SYSTEM 命令报告的最新 WAL 刷新位置。
如果连接丢失，或者无法在非致命错误的情况下最初建立连接，pg_receivewal 将无限期地重试连接，并在尽快重新建立流式传输。为了避免这种行为，请使用 -n 参数。
在没有致命错误的情况下，pg_receivewal 将一直运行，直到被 SIGINT (Control+C) 或 SIGTERM 信号终止。
-D 目录--directory=目录写入输出的目录。
此参数是必需的。
-E lsn--endpos=lsn当接收达到指定的 LSN 时，自动停止复制并以正常退出状态 0 退出。
如果存在 LSN 恰好等于 lsn 的记录，则会处理该记录。
--if-not-exists当指定 --create-slot 并且存在具有指定名称的槽时，不要出错。
-n--no-loop不要在连接错误时循环。相反，立即以错误退出。
--no-sync此选项会导致 pg_receivewal 不强制将 WAL 数据刷新到磁盘。这更快，但意味着后续的操作系统崩溃可能会使 WAL 段损坏。通常，此选项对于测试很有用，但在生产部署中进行 WAL 归档时不应使用此选项。
此选项与 --synchronous 不兼容。
-s 间隔--status-interval=间隔指定发送回服务器的状态包之间的秒数。这允许更轻松地监控来自服务器的进度。值为零将完全禁用定期状态更新，尽管在服务器请求时仍会发送更新，以避免超时断开连接。默认值为 10 秒。
-S 槽名--slot=槽名要求 pg_receivewal 使用现有的复制槽（参见 第 26.2.6 节）。当使用此选项时，pg_receivewal 会向服务器报告刷新位置，指示每个段何时已同步到磁盘，以便服务器可以删除该段（如果不再需要）。
当 pg_receivewal 的复制客户端在服务器上配置为同步备用时，使用复制槽将向服务器报告刷新位置，但仅在 WAL 文件关闭时。因此，该配置会导致主服务器上的事务等待很长时间，实际上无法令人满意地工作。除了使此操作正常工作外，还必须指定选项 --synchronous（见下文）。
--synchronous在接收到 WAL 数据后立即将其刷新到磁盘。此外，无论 --status-interval 如何，都在刷新后立即向服务器发送状态包。
如果 pg_receivewal 的复制客户端在服务器上配置为同步备用，则应指定此选项，以确保及时将反馈发送到服务器。
-v--verbose启用详细模式。
-Z 级别-Z 方法[:细节]--compress=级别--compress=方法[:细节]启用预写日志的压缩。
压缩方法可以设置为 gzip、lz4（如果 PostgreSQL 使用 --with-lz4 编译）或 none 表示不压缩。可以选择指定压缩详细信息字符串。如果详细信息字符串是整数，则它指定压缩级别。否则，它应该是逗号分隔的项目列表，每个项目都采用 关键字 或 关键字=值 的形式。目前，唯一支持的关键字是 level。
如果未指定压缩级别，则将使用默认压缩级别。如果仅指定级别而未提及算法，则如果级别大于 0，则将使用 gzip 压缩；如果级别为 0，则不使用压缩。
使用 gzip 时，后缀 .gz 会自动添加到所有文件名；使用 lz4 时，会添加后缀 .lz4。
以下命令行选项控制数据库连接参数。
-d connstr--dbname=connstr指定用于连接到服务器的参数，作为 连接字符串；这些将覆盖任何冲突的命令行选项。
该选项被称为 --dbname，以保持与其他客户端应用程序的一致性，但由于 pg_receivewal 不连接到集群中的任何特定数据库，因此连接字符串中的任何数据库名称都会被 PostgreSQL 忽略。但是，连接到 PostgreSQL 时使用的中间件或代理可能会使用该值。
-h 主机--host=主机指定运行服务器的机器的主机名。如果该值以斜杠开头，则它将用作 Unix 域套接字的目录。默认值取自 PGHOST 环境变量（如果已设置），否则将尝试进行 Unix 域套接字连接。
-p 端口--port=端口指定服务器正在监听连接的 TCP 端口或本地 Unix 域套接字文件扩展名。默认为 PGPORT 环境变量（如果已设置），或编译的默认值。
-U 用户名--username=用户名要连接到的用户名。
-w--no-password永不发出密码提示。如果服务器需要密码身份验证并且无法通过其他方式（如 .pgpass 文件）获取密码，则连接尝试将失败。此选项在没有用户可以输入密码的批处理作业和脚本中很有用。
-W--password强制 pg_receivewal 在连接到数据库之前提示输入密码。
此选项绝非必需，因为如果服务器要求密码身份验证，pg_receivewal 会自动提示输入密码。但是，pg_receivewal 会浪费一次连接尝试来发现服务器需要密码。在某些情况下，输入 -W 以避免额外的连接尝试是值得的。
pg_receivewal 可以执行以下两种操作之一来控制物理复制槽
--create-slot创建一个新的物理复制槽，槽名在 --slot 中指定，然后退出。
--drop-slot删除在 --slot 中指定的槽名的复制槽，然后退出。
还有其他选项可用
-V--version打印 pg_receivewal 版本并退出。
-?--help显示有关 pg_receivewal 命令行参数的帮助信息，并退出。
pg_receivewal 在被 SIGINT 或 SIGTERM 信号终止时，将以状态 0 退出。（这是正常的结束方式。因此这不是错误。）对于致命错误或其他信号，退出状态将是非零的。
此实用程序与大多数其他 PostgreSQL 实用程序一样，使用 libpq 支持的环境变量（参见 第 32.15 节）。
环境变量 PG_COLOR 指定是否在诊断消息中使用颜色。可能的值是 always、auto 和 never。
当使用 pg_receivewal 而不是 archive_command 或 archive_library 作为主要 WAL 备份方法时，强烈建议使用复制槽。否则，服务器可以在备份之前自由回收或删除预写日志文件，因为它没有来自 archive_command 或 archive_library 或复制槽的任何信息，关于 WAL 流已存档到什么程度。但是请注意，如果接收器跟不上 WAL 数据的获取速度，则复制槽会填满服务器的磁盘空间。
pg_receivewal 会在源集群上启用了组权限的情况下，保留接收到的 WAL 文件的组权限。
要从 mydbserver 上的服务器流式传输预写日志，并将其存储在本地目录 /usr/local/pgsql/archive 中
$pg_receivewal -h mydbserver -D /usr/local/pgsql/archive
如果您在文档中发现任何错误，与您对特定功能的体验不符，或者需要进一步澄清，请使用 此表格 报告文档问题。