アーカイブコールバックは、モジュールの実際のアーカイブ動作を定義します。 サーバは、個々のWALファイルを処理するために必要に応じてこれらを呼び出します。
check_configured_cb
コールバックは、モジュールが完全に設定されていて、WALファイルを受け入れる準備ができているかどうかを判断するために呼び出されます(たとえば、構成パラメータが適切な値に設定されているかどうかを判断します)。
check_configured_cb
が定義されていない場合、サーバは常にモジュールが設定されていると想定します。
typedef bool (*ArchiveCheckConfiguredCB) (void);
true
が返された場合、サーバはarchive_file_cb
コールバックを呼び出してファイルのアーカイブを続行します。
false
が返された場合、アーカイブは続行されず、アーカイバはサーバログに次のメッセージを出力します:
WARNING: archive_mode enabled, yet archiving is not configured
後者の場合、サーバは定期的にこの関数を呼び出し、true
が返された場合のみアーカイブが続行されます。
archive_file_cb
コールバックは、単一のWALファイルをアーカイブするために呼び出されます。
typedef bool (*ArchiveFileCB) (const char *file, const char *path);
true
が返された場合、サーバはファイルが正常にアーカイブされたかのように処理を進めます。
これには元のWALファイルのリサイクルまたは削除が含まれる場合があります。
false
が返された場合、サーバは元のWALファイルを保持し、後でアーカイブを再試行します。
file
にはアーカイブするWALファイルのファイル名だけが含まれ、path
にはWALファイルのフルパス(ファイル名を含む)が含まれます。
shutdown_cb
コールバックは、アーカイバプロセスが終了したとき(たとえばエラー後など)、またはarchive_libraryの値が変更されたときに呼び出されます。
shutdown_cb
が定義されていない場合、このような状況では特別な処理は行われません。
typedef void (*ArchiveShutdownCB) (void);