diff options
| author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 13:44:03 +0000 |
|---|---|---|
| committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 13:44:03 +0000 |
| commit | 293913568e6a7a86fd1479e1cff8e2ecb58d6568 (patch) | |
| tree | fc3b469a3ec5ab71b36ea97cc7aaddb838423a0c /doc/src/sgml/html/basic-archive.html | |
| parent | Initial commit. (diff) | |
| download | postgresql-16-293913568e6a7a86fd1479e1cff8e2ecb58d6568.tar.xz postgresql-16-293913568e6a7a86fd1479e1cff8e2ecb58d6568.zip | |
Adding upstream version 16.2.upstream/16.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/src/sgml/html/basic-archive.html')
| -rw-r--r-- | doc/src/sgml/html/basic-archive.html | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/src/sgml/html/basic-archive.html b/doc/src/sgml/html/basic-archive.html new file mode 100644 index 0000000..425d308 --- /dev/null +++ b/doc/src/sgml/html/basic-archive.html @@ -0,0 +1,38 @@ +<?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>F.6. basic_archive — an example WAL archive module</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="basebackup-to-shell.html" title="F.5. basebackup_to_shell — example "shell" pg_basebackup module" /><link rel="next" href="bloom.html" title="F.7. bloom — bloom filter index access method" /></head><body id="docContent" class="container-fluid col-10"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="5" align="center">F.6. basic_archive — an example WAL archive module</th></tr><tr><td width="10%" align="left"><a accesskey="p" href="basebackup-to-shell.html" title="F.5. basebackup_to_shell — example "shell" pg_basebackup module">Prev</a> </td><td width="10%" align="left"><a accesskey="u" href="contrib.html" title="Appendix F. Additional Supplied Modules and Extensions">Up</a></td><th width="60%" align="center">Appendix F. Additional Supplied Modules and Extensions</th><td width="10%" align="right"><a accesskey="h" href="index.html" title="PostgreSQL 16.2 Documentation">Home</a></td><td width="10%" align="right"> <a accesskey="n" href="bloom.html" title="F.7. bloom — bloom filter index access method">Next</a></td></tr></table><hr /></div><div class="sect1" id="BASIC-ARCHIVE"><div class="titlepage"><div><div><h2 class="title" style="clear: both">F.6. basic_archive — an example WAL archive module <a href="#BASIC-ARCHIVE" class="id_link">#</a></h2></div></div></div><div class="toc"><dl class="toc"><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-CONFIGURATION-PARAMETERS">F.6.1. Configuration Parameters</a></span></dt><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-NOTES">F.6.2. Notes</a></span></dt><dt><span class="sect2"><a href="basic-archive.html#BASIC-ARCHIVE-AUTHOR">F.6.3. Author</a></span></dt></dl></div><a id="id-1.11.7.16.2" class="indexterm"></a><p> + <code class="filename">basic_archive</code> is an example of an archive module. This + module copies completed WAL segment files to the specified directory. This + may not be especially useful, but it can serve as a starting point for + developing your own archive module. For more information about archive + modules, see <a class="xref" href="archive-modules.html" title="Chapter 51. Archive Modules">Chapter 51</a>. + </p><p> + In order to function, this module must be loaded via + <a class="xref" href="runtime-config-wal.html#GUC-ARCHIVE-LIBRARY">archive_library</a>, and <a class="xref" href="runtime-config-wal.html#GUC-ARCHIVE-MODE">archive_mode</a> + must be enabled. + </p><div class="sect2" id="BASIC-ARCHIVE-CONFIGURATION-PARAMETERS"><div class="titlepage"><div><div><h3 class="title">F.6.1. Configuration Parameters <a href="#BASIC-ARCHIVE-CONFIGURATION-PARAMETERS" class="id_link">#</a></h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> + <code class="varname">basic_archive.archive_directory</code> (<code class="type">string</code>) + <a id="id-1.11.7.16.5.2.1.1.3" class="indexterm"></a> + </span></dt><dd><p> + The directory where the server should copy WAL segment files. This + directory must already exist. The default is an empty string, which + effectively halts WAL archiving, but if <a class="xref" href="runtime-config-wal.html#GUC-ARCHIVE-MODE">archive_mode</a> + is enabled, the server will accumulate WAL segment files in the + expectation that a value will soon be provided. + </p></dd></dl></div><p> + These parameters must be set in <code class="filename">postgresql.conf</code>. + Typical usage might be: + </p><pre class="programlisting"> +# postgresql.conf +archive_mode = 'on' +archive_library = 'basic_archive' +basic_archive.archive_directory = '/path/to/archive/directory' +</pre></div><div class="sect2" id="BASIC-ARCHIVE-NOTES"><div class="titlepage"><div><div><h3 class="title">F.6.2. Notes <a href="#BASIC-ARCHIVE-NOTES" class="id_link">#</a></h3></div></div></div><p> + Server crashes may leave temporary files with the prefix + <code class="filename">archtemp</code> in the archive directory. It is recommended to + delete such files before restarting the server after a crash. It is safe to + remove such files while the server is running as long as they are unrelated + to any archiving still in progress, but users should use extra caution when + doing so. + </p></div><div class="sect2" id="BASIC-ARCHIVE-AUTHOR"><div class="titlepage"><div><div><h3 class="title">F.6.3. Author <a href="#BASIC-ARCHIVE-AUTHOR" class="id_link">#</a></h3></div></div></div><p> + Nathan Bossart + </p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="basebackup-to-shell.html" title="F.5. basebackup_to_shell — example "shell" pg_basebackup module">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="contrib.html" title="Appendix F. Additional Supplied Modules and Extensions">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bloom.html" title="F.7. bloom — bloom filter index access method">Next</a></td></tr><tr><td width="40%" align="left" valign="top">F.5. basebackup_to_shell — example "shell" pg_basebackup module </td><td width="20%" align="center"><a accesskey="h" href="index.html" title="PostgreSQL 16.2 Documentation">Home</a></td><td width="40%" align="right" valign="top"> F.7. bloom — bloom filter index access method</td></tr></table></div></body></html>
\ No newline at end of file |