2024 年 9 月 26 日: PostgreSQL 17 发布!
支持版本:当前 (17) / 16 / 15 / 14 / 13 / 12
开发版本:devel
不受支持的版本:11 / 10 / 9.6 / 9.5 / 9.4 / 9.3 / 9.2 / 9.1 / 9.0

pg_archivecleanup

pg_archivecleanup — 清理 PostgreSQL WAL 归档文件

语法

pg_archivecleanup [选项...] 归档位置 最旧保留 WAL 文件

描述

pg_archivecleanup 旨在用作 archive_cleanup_command,用于在作为备用服务器运行时清理 WAL 文件归档(参见 第 26.2 节)。pg_archivecleanup 也可以用作独立程序来清理 WAL 文件归档。

要配置备用服务器使用 pg_archivecleanup,请将其放入其 postgresql.conf 配置文件

archive_cleanup_command = 'pg_archivecleanup archivelocation %r'

其中 归档位置 是应从中删除 WAL 段文件的目录。

archive_cleanup_command 中使用时,所有在逻辑上早于 %r 参数值的 WAL 文件都将从 归档位置 中删除。这最大限度地减少了需要保留的文件数量,同时保留了崩溃重启功能。如果 归档位置 是此特定备用服务器的临时暂存区域,则使用此参数是合适的,但 归档位置 旨在作为长期 WAL 归档区域,或当多个备用服务器从同一个归档位置恢复时。

当用作独立程序时,所有在逻辑上早于 最旧保留 WAL 文件 的 WAL 文件都将从 归档位置 中删除。在此模式下,如果您指定 .partial.backup 文件名,则仅文件前缀将用作 最旧保留 WAL 文件。这种对 .backup 文件名的处理允许您在不出现错误的情况下删除在特定基本备份之前存档的所有 WAL 文件。例如,以下示例将删除所有早于 WAL 文件名 000000010000003700000010 的文件

pg_archivecleanup -d archive 000000010000003700000010.00000020.backup

pg_archivecleanup:  keep WAL file "archive/000000010000003700000010" and later
pg_archivecleanup:  removing file "archive/00000001000000370000000F"
pg_archivecleanup:  removing file "archive/00000001000000370000000E"

pg_archivecleanup 假设 归档位置 是服务器拥有者用户可读写的目录。

选项

pg_archivecleanup 接受以下命令行参数

-b
--clean-backup-history

还删除备份历史文件。有关备份历史文件的详细信息,请参见 第 25.3.2 节

-d
--debug

stderr 上打印大量调试日志输出。

-n
--dry-run

stdout 上打印将要删除的文件的名称(执行干运行)。

-V
--version

打印 pg_archivecleanup 版本并退出。

-x 扩展名
--strip-extension=扩展名

提供一个将在决定是否应该删除所有文件名之前从所有文件名中剥离的扩展名。这通常用于清理在存储过程中已压缩的存档,因此压缩程序已添加了一个扩展名。例如:-x .gz

-?
--help

显示有关 pg_archivecleanup 命令行参数的帮助,然后退出。

环境

环境变量 PG_COLOR 指定是否在诊断消息中使用颜色。可能的值是 alwaysautonever

注意

pg_archivecleanup 旨在与用作独立实用程序的 PostgreSQL 8.0 及更高版本,或用作存档清理命令的 PostgreSQL 9.0 及更高版本一起使用。

pg_archivecleanup 是用 C 编写的,具有易于修改的源代码,并有专门指定的部分供您根据自己的需要进行修改

示例

在 Linux 或 Unix 系统上,您可能会使用

archive_cleanup_command = 'pg_archivecleanup -d /mnt/standby/archive %r 2>>cleanup.log'

其中存档目录物理上位于备用服务器上,以便 archive_command 通过 NFS 访问它,但文件是备用服务器本地的。这将

  • cleanup.log 中生成调试输出

  • 从存档目录中删除不再需要的文件

提交更正

如果您在文档中看到任何不正确的内容,与您对特定功能的体验不符,或者需要进一步澄清,请使用 此表格 报告文档问题。