pgsql-jp.github.io/jpug-doc/14.0/html/archive-module-callbacks.html at master · pgsql-jp/pgsql-jp.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>51.2. Archive Module Callbacks</title><link rel="stylesheet" type="text/css" href="stylesheet.css" /><link rev="made" href="pgsql-docs@lists.postgresql.org" /><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><link rel="prev" href="archive-module-init.html" title="51.1. Initialization Functions" /><link rel="next" href="reference.html" title="パート VI. リファレンス" /><meta name="viewport" content="width=device-width,initial-scale=1.0" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="4" align="center"><a accesskey="h" href="index.html">PostgreSQL 15beta3文書</a></th></tr><tr><td width="10%" align="left"></td><td width="10%" align="left"></td><td width="60%" align="center"><a href="archive-modules.html" title="第51章 Archive Modules">第51章 Archive Modules</a></td><td width="20%" align="right"></td></tr><tr><td width="10%" align="left"><a accesskey="p" href="archive-module-init.html" title="51.1. Initialization Functions">前へ</a> </td><td width="10%" align="left"><a accesskey="u" href="archive-modules.html" title="第51章 Archive Modules">上へ</a></td><td width="60%" align="center">51.2. Archive Module Callbacks</td><td width="20%" align="right"> <a accesskey="n" href="reference.html" title="パート VI. リファレンス">次へ</a></td></tr></table><hr /></div><div class="sect1" id="ARCHIVE-MODULE-CALLBACKS"><div class="titlepage"><div><div><h2 class="title" style="clear: both">51.2. Archive Module Callbacks</h2></div></div></div><p>
   The archive callbacks define the actual archiving behavior of the module.
   The server will call them as required to process each individual WAL file.
  </p><div class="sect2" id="ARCHIVE-MODULE-CHECK"><div class="titlepage"><div><div><h3 class="title">51.2.1. Check Callback</h3></div></div></div><p>
    The <code class="function">check_configured_cb</code> callback is called to determine
    whether the module is fully configured and ready to accept WAL files (e.g.,
    its configuration parameters are set to valid values).  If no
    <code class="function">check_configured_cb</code> is defined, the server always
    assumes the module is configured.

</p><pre class="programlisting">
typedef bool (*ArchiveCheckConfiguredCB) (void);
</pre><p>

    If <code class="literal">true</code> is returned, the server will proceed with
    archiving the file by calling the <code class="function">archive_file_cb</code>
    callback.  If <code class="literal">false</code> is returned, archiving will not
    proceed, and the archiver will emit the following message to the server log:
</p><pre class="screen">
WARNING:  archive_mode enabled, yet archiving is not configured
</pre><p>
    In the latter case, the server will periodically call this function, and
    archiving will proceed only when it returns <code class="literal">true</code>.
   </p></div><div class="sect2" id="ARCHIVE-MODULE-ARCHIVE"><div class="titlepage"><div><div><h3 class="title">51.2.2. Archive Callback</h3></div></div></div><p>
    The <code class="function">archive_file_cb</code> callback is called to archive a
    single WAL file.

</p><pre class="programlisting">
typedef bool (*ArchiveFileCB) (const char *file, const char *path);
</pre><p>

    If <code class="literal">true</code> is returned, the server proceeds as if the file
    was successfully archived, which may include recycling or removing the
    original WAL file.  If <code class="literal">false</code> is returned, the server will
    keep the original WAL file and retry archiving later.
    <code class="literal">file</code> will contain just the file name of the WAL file to
    archive, while <code class="literal">path</code> contains the full path of the WAL
    file (including the file name).
   </p></div><div class="sect2" id="ARCHIVE-MODULE-SHUTDOWN"><div class="titlepage"><div><div><h3 class="title">51.2.3. Shutdown Callback</h3></div></div></div><p>
    The <code class="function">shutdown_cb</code> callback is called when the archiver
    process exits (e.g., after an error) or the value of
    <a class="xref" href="runtime-config-wal.html#GUC-ARCHIVE-LIBRARY">archive_library</a> changes.  If no
    <code class="function">shutdown_cb</code> is defined, no special action is taken in
    these situations.

</p><pre class="programlisting">
typedef void (*ArchiveShutdownCB) (void);
</pre><p>
   </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="archive-module-init.html" title="51.1. Initialization Functions">前へ</a> </td><td width="20%" align="center"><a accesskey="u" href="archive-modules.html" title="第51章 Archive Modules">上へ</a></td><td width="40%" align="right"> <a accesskey="n" href="reference.html" title="パート VI. リファレンス">次へ</a></td></tr><tr><td width="40%" align="left" valign="top">51.1. Initialization Functions </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 15beta3文書">ホーム</a></td><td width="40%" align="right" valign="top"> パート VI. リファレンス</td></tr></table></div></body></html>