金仓数据库KingbaseES服务器应用参考手册--3. sys_archivecleanup

3.1. 简介：

sys_archivecleanup— 清理KingbaseES WAL 归档文件。

sys_archivecleanup可供备节点服务器通过 archive_cleanup_command来清理 WAL 文件归档。 sys_archivecleanup也可以作为一个单独的程序运行，清理 WAL 文件归档。

在备节点服务器上使用 sys_archivecleanup，需在kingbase.conf配置文件中配置以下内容：

archive_cleanup_command = 'sys_archivecleanup archivelocation %r'

其中archivelocation是要移除的 WAL 段文件的目录。当被用在 archive_cleanup_command 时，所有逻辑上在 %r参数值之前的 WAL 文件都将从archivelocation中被移除。这样保留了最少的文件，同时仍具备崩溃后重启的能力。

对于这台特定的备节点服务器，如果archivelocation是用作一个保存瞬时状态的区域，那使用这个参数就是合适的，但是当archivelocation要用作一个长期的 WAL 归档区域或者当多个备节点服务器正在从这个归档位置恢复时，使用这个参数就不合适。

当被用作一个单独的程序时，所有逻辑上早于oldestkeptwalfile的 WAL 文件都将从archivelocation中被移除。在这种模式中，如果指定了.partial或者.backup文件名，则只有该文件前缀将被用作oldestkeptwalfile。

这种对.backup文件名的处理，可以在不出错的情况下移除在特定基础备份之前归档的 WAL 文件。例如，下面的例子将移除所有早于 WAL 文件 000000010000003700000010的文件：

sys_archivecleanup -d archive 000000010000003700000010.00000020.backup
sys_archivecleanup:  keep WAL file "archive/000000010000003700000010" and later
sys_archivecleanup:  removing file "archive/00000001000000370000000F"
sys_archivecleanup:  removing file "archive/00000001000000370000000E"

3.2. 命令行参数：

sys_archivecleanup [option...] archivelocation oldestkeptwalfile

3.3. 参数说明：

sys_archivecleanup接受下列命令行参数：

-d

在stderr上打印很多调试日志输出。

-n

在stdout上打印将被移除的文件的名字（执行一次演习）。

-V

--version

打印 sys_archivecleanup版本并退出。

-x extension

提供一个文件名后缀，在决定文件是否应该被删除之前，从文件名中剥离这个后缀。这通常有助于清理被压缩后增加了一个文件名后缀的归档文件。例如： -x .gz。

-?

--help

显示 sys_archivecleanup命令行参数的帮助并退出。

3.4. 环境变量：

无

3.5. 错误信息诊断：

无

3.6. 备注：

在作为一个单独的工具时， sys_archivecleanup被设计为与KingbaseES V7及其后的版本一起工作。如果作为一个归档清理命令使用，则需要和KingbaseES V8.2 及其后的版本一起工作。

sys_archivecleanup以 C 语言实现，源码具有易修改性，其中有特定的区域可用于修改以符合特定需求。

3.7. 示例:

在 Linux 或者 Unix 系统上：

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

其中归档目录位于备节点服务器上，这样archive_command通过 NFS 来访问它，但是文件对于备节点服务器来说是本地的。这将会

• 在cleanup.log中产生调试输出

• 从归档目录中移除不再需要的文件

3.8. 参考：

无