存档回调函数定义模块的实际存档行为。 服务器将根据需要调用它们来处理每个单独的WAL文件。
在模块加载后不久会调用startup_cb
回调。此回调可用于执行
任何所需的额外初始化。如果归档模块有任何状态,可以使用
state->private_data
来存储它。
typedef void (*ArchiveStartupCB) (ArchiveModuleState *state);
check_configured_cb
回调函数被调用以确定模块是否已完全配置并准备好接
收 WAL 文件(例如,其配置参数已设置为有效值)。如果未定义
check_configured_cb
,服务器始终假定模块已配置。
typedef bool (*ArchiveCheckConfiguredCB) (ArchiveModuleState *state);
如果返回 true
,服务器将通过调用 archive_file_cb
回调
函数继续归档文件。如果返回 false
,归档将不会继续,归档器将向服务器日志
输出以下消息:
WARNING: archive_mode enabled, yet archiving is not configured
在后一种情况下,服务器将定期调用此函数,并且只有当其返回 true
时,归档
才会继续。
返回false
时,附加一些额外信息到通用警告消息可能会很有用。
为此,在返回false
之前,向arch_module_check_errdetail
宏
提供一条消息。像errdetail()
一样,该宏接受一个格式字符串,
后跟可选的参数列表。生成的字符串将作为警告消息的DETAIL
行发出。
archive_file_cb
回调函数被调用以归档单个 WAL 文件。
typedef bool (*ArchiveFileCB) (ArchiveModuleState *state, const char *file, const char *path);
如果返回 true
,服务器将继续处理,仿佛文件已成功归档,
这可能包括回收或删除原始 WAL 文件。如果返回 false
或抛出错误,
服务器将保留原始 WAL 文件并稍后重试归档。file
只包含
要归档的 WAL 文件名,而 path
包含 WAL 文件的完整路径
(包括文件名)。
archive_file_cb
回调函数在一个短暂的内存上下文中被调用,
该上下文将在每次调用之间重置。如果您需要更长生命周期的存储,
请在模块的 startup_cb
回调中创建一个内存上下文。
当归档器进程退出(例如,发生错误后)或
archive_library 的值发生变化时,会调用
shutdown_cb
回调。如果没有定义
shutdown_cb
,在这些情况下不会采取特殊操作。
如果归档模块有任何状态,此回调应释放它以避免内存泄漏。
typedef void (*ArchiveShutdownCB) (ArchiveModuleState *state);