pg_archivecleanup — 清理PostgreSQL WAL 归档文件
pg_archivecleanup [option...] archivelocation oldestkeptwalfile
pg_archivecleanup设计为在服务器作为备库运行时用作 archive_cleanup_command,以清理 WAL 文件归档(见 Section 26.2)。 pg_archivecleanup也可作为独立程序使用,以清理 WAL 文件归档。
要将备库配置为使用 pg_archivecleanup,请将以下内容写入其 postgresql.conf 配置文件:
archive_cleanup_command = 'pg_archivecleanup archivelocation %r'
其中 archivelocation 是应移除 WAL 段文件的目录。
当在 archive_cleanup_command 中使用时,逻辑上早于 %r 参数值的所有 WAL 文件都会从 archivelocation 中移除。这样既能将需要保留的文件数量降到最低,又能保留崩溃后重启能力。如果 archivelocation 只是该特定备库的临时暂存区,那么使用此参数 是合适的;但如果 archivelocation 打算作为长期 WAL 归档区域, 或者有多个备库正从同一归档位置恢复,则不适合使用此参数。
作为独立程序使用时,逻辑上早于 oldestkeptwalfile 的所有 WAL 文件都会从 archivelocation 中移除。在此模式下,如果指定的是 .partial 或 .backup 文件名,则仅使用其文件名前缀 作为 oldestkeptwalfile。这样处理 .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 假定 archivelocation 是服务器属主用户可读写的目录。
pg_archivecleanup 接受下列命令行参数:
-b--clean-backup-history同时移除备份历史文件。关于备份历史文件的详细信息,见 Section 25.3.2。
-d--debug在 stderr 上输出大量调试日志。
-n--dry-run在 stdout 上打印原本会被移除的文件名(执行试运行)。
-V--version输出 pg_archivecleanup 的版本号并退出。
-x extension--strip-extension=extension指定一个扩展名;在判断文件是否应删除之前,会先从所有文件名中去掉该扩展名。 这通常适用于清理由于存储时经过压缩、因而被压缩程序附加了扩展名的归档。 例如:-x .gz。
-?--help显示有关 pg_archivecleanup 命令行参数的帮助并退出。
环境变量 PG_COLOR 指定是否在诊断消息中使用颜色。可能的值为 always、auto 和 never。
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 中产生调试输出
从归档目录中移除不再需要的文件
如果您发现文档中有不正确的内容、与您使用特定功能的经验不符或需要进一步说明,请使用此表单来报告文档问题。