Datasetpublic
codekingpro/portable-devtools

sourceHugging Faceupdated 5mo agoView on Hugging Face
1likes15kdownloads
rootpgsqldocpostgresqlhtmlarchive-module-callbacks.html
archive-module-callbacks.html60 linesDownload Raw Back to html
1<?xml version="1.0" encoding="UTF-8" standalone="no"?>2<!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="Part VI. Reference" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">51.2. Archive Module Callbacks</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="archive-module-init.html" title="51.1. Initialization Functions">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="archive-modules.html" title="Chapter 51. Archive Modules">Up</a></td><th width="60%" align="center">Chapter 51. Archive Modules</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.3 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="reference.html" title="Part VI. Reference">Next</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 <a href="#ARCHIVE-MODULE-CALLBACKS" class="id_link">#</a></h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="archive-module-callbacks.html#ARCHIVE-MODULE-STARTUP">51.2.1. Startup Callback</a></span></dt><dt><span class="sect2"><a href="archive-module-callbacks.html#ARCHIVE-MODULE-CHECK">51.2.2. Check Callback</a></span></dt><dt><span class="sect2"><a href="archive-module-callbacks.html#ARCHIVE-MODULE-ARCHIVE">51.2.3. Archive Callback</a></span></dt><dt><span class="sect2"><a href="archive-module-callbacks.html#ARCHIVE-MODULE-SHUTDOWN">51.2.4. Shutdown Callback</a></span></dt></dl></div><p>3   The archive callbacks define the actual archiving behavior of the module.4   The server will call them as required to process each individual WAL file.5  </p><div class="sect2" id="ARCHIVE-MODULE-STARTUP"><div class="titlepage"><div><div><h3 class="title">51.2.1. Startup Callback <a href="#ARCHIVE-MODULE-STARTUP" class="id_link">#</a></h3></div></div></div><p>6    The <code class="function">startup_cb</code> callback is called shortly after the7    module is loaded.  This callback can be used to perform any additional8    initialization required.  If the archive module has any state, it can use9    <code class="structfield">state-&gt;private_data</code> to store it.10 11</p><pre class="programlisting">12typedef void (*ArchiveStartupCB) (ArchiveModuleState *state);13</pre><p>14   </p></div><div class="sect2" id="ARCHIVE-MODULE-CHECK"><div class="titlepage"><div><div><h3 class="title">51.2.2. Check Callback <a href="#ARCHIVE-MODULE-CHECK" class="id_link">#</a></h3></div></div></div><p>15    The <code class="function">check_configured_cb</code> callback is called to determine16    whether the module is fully configured and ready to accept WAL files (e.g.,17    its configuration parameters are set to valid values).  If no18    <code class="function">check_configured_cb</code> is defined, the server always19    assumes the module is configured.20 21</p><pre class="programlisting">22typedef bool (*ArchiveCheckConfiguredCB) (ArchiveModuleState *state);23</pre><p>24 25    If <code class="literal">true</code> is returned, the server will proceed with26    archiving the file by calling the <code class="function">archive_file_cb</code>27    callback.  If <code class="literal">false</code> is returned, archiving will not28    proceed, and the archiver will emit the following message to the server log:29</p><pre class="screen">30WARNING:  archive_mode enabled, yet archiving is not configured31</pre><p>32    In the latter case, the server will periodically call this function, and33    archiving will proceed only when it returns <code class="literal">true</code>.34   </p></div><div class="sect2" id="ARCHIVE-MODULE-ARCHIVE"><div class="titlepage"><div><div><h3 class="title">51.2.3. Archive Callback <a href="#ARCHIVE-MODULE-ARCHIVE" class="id_link">#</a></h3></div></div></div><p>35    The <code class="function">archive_file_cb</code> callback is called to archive a36    single WAL file.37 38</p><pre class="programlisting">39typedef bool (*ArchiveFileCB) (ArchiveModuleState *state, const char *file, const char *path);40</pre><p>41 42    If <code class="literal">true</code> is returned, the server proceeds as if the file43    was successfully archived, which may include recycling or removing the44    original WAL file.  If <code class="literal">false</code> is returned, the server will45    keep the original WAL file and retry archiving later.46    <em class="replaceable"><code>file</code></em> will contain just the file name of the WAL47    file to archive, while <em class="replaceable"><code>path</code></em> contains the full48    path of the WAL file (including the file name).49   </p></div><div class="sect2" id="ARCHIVE-MODULE-SHUTDOWN"><div class="titlepage"><div><div><h3 class="title">51.2.4. Shutdown Callback <a href="#ARCHIVE-MODULE-SHUTDOWN" class="id_link">#</a></h3></div></div></div><p>50    The <code class="function">shutdown_cb</code> callback is called when the archiver51    process exits (e.g., after an error) or the value of52    <a class="xref" href="runtime-config-wal.html#GUC-ARCHIVE-LIBRARY">archive_library</a> changes.  If no53    <code class="function">shutdown_cb</code> is defined, no special action is taken in54    these situations.  If the archive module has any state, this callback should55    free it to avoid leaks.56 57</p><pre class="programlisting">58typedef void (*ArchiveShutdownCB) (ArchiveModuleState *state);59</pre><p>60   </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">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="archive-modules.html" title="Chapter 51. Archive Modules">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="reference.html" title="Part VI. Reference">Next</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 16.3 Documentation">Home</a></td><td width="40%" align="right" valign="top"> Part VI. Reference</td></tr></table></div></body></html>