Redrock Postgres 搜索 英文
版本: 15 / 16 / 17

49.2. 归档模块回调 #

49.2.1. 启动回调
49.2.2. 检查回调
49.2.3. 归档回调
49.2.4. 关闭回调

归档回调定义模块的实际归档行为。服务器将按要求调用它们来处理每个单独的 WAL 文件。

49.2.1. 启动回调 #

在加载模块后不久将调用 startup_cb 回调。此回调可用于执行所需的任何附加初始化。如果归档模块有任何状态,它可以使用 state->private_data 来存储它。

typedef void (*ArchiveStartupCB) (ArchiveModuleState *state);

49.2.2. 检查回调 #

调用 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 行发出。

49.2.3. 存档回调 #

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 回调中创建一个内存上下文。

49.2.4. 关闭回调 #

归档进程退出时(例如,在发生错误后)或 archive_library 的值发生更改时,将调用 shutdown_cb 回调。如果未定义 shutdown_cb,则在这些情况下不会执行任何特殊操作。如果存档模块有任何状态,则此回调应释放它以避免泄露。

typedef void (*ArchiveShutdownCB) (ArchiveModuleState *state);