database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-27 12:41:57 +03:00
Code Activity

Rename contrib module basic_archive to basic_wal_module

Browse Source 
This rename is in preparation for the introduction of recovery modules,
where basic_wal_module will be used as a base template for the set of
callbacks introduced.  The former name did not really reflect all that.

Author: Nathan Bossart
Discussion: https://postgr.es/m/20221227192449.GA3672473@nathanxps13
This commit is contained in:
Michael Paquier
2023-01-25 14:36:51 +09:00
parent 239b175342
commit 0ad3c60caf
17 changed files with 105 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/src/sgml/appendix-obsolete-basic-archive.sgml Normal file
View File

@ -0,0 +1,25 @@
<!-- doc/src/sgml/appendix-obsolete-basic-archive.sgml -->
<!--
See doc/src/sgml/appendix-obsolete.sgml for why this file exists. Do not change the id attribute.
-->
<sect1 id="basic-archive" xreflabel="basic_archive">
<title><command>basic_archive</command> renamed to <command>basic_wal_module</command></title>
<indexterm>
<primary>basic_archive</primary>
<see>basic_wal_module</see>
</indexterm>
<para>
PostgreSQL 15 provided an archive module named
<filename>basic_archive</filename>
<indexterm><primary>basic_archive</primary></indexterm>.
This module was renamed to <filename>basic_wal_module</filename>. See
<xref linkend="basic-wal-module"/> for documentation of
<filename>basic_wal_module</filename>, and see
<link linkend="release-prior">the release notes for PostgreSQL 16</link>
for details on this change.
</para>
</sect1>

1
doc/src/sgml/appendix-obsolete.sgml
View File

@ -38,5 +38,6 @@
&obsolete-pgxlogdump;
&obsolete-pgresetxlog;
&obsolete-pgreceivexlog;
&obsolete-basic-archive;
</appendix>

2
doc/src/sgml/archive-modules.sgml
View File

@ -32,7 +32,7 @@
</para>
<para>
The <filename>contrib/basic_archive</filename> module contains a working
The <filename>contrib/basic_wal_module</filename> module contains a working
example, which demonstrates some useful techniques.
</para>

30
doc/src/sgml/basic-archive.sgml → doc/src/sgml/basic-wal-module.sgml
View File

@ -1,16 +1,16 @@
<!-- doc/src/sgml/basic-archive.sgml -->
<!-- doc/src/sgml/basic-wal-module.sgml -->
<sect1 id="basic-archive" xreflabel="basic_archive">
<title>basic_archive &mdash; an example WAL archive module</title>
<sect1 id="basic-wal-module" xreflabel="basic_wal_module">
<title>basic_wal_module &mdash; an example write-ahead log module</title>
<indexterm zone="basic-archive">
<primary>basic_archive</primary>
<indexterm zone="basic-wal-module">
<primary>basic_wal_module</primary>
</indexterm>
<para>
<filename>basic_archive</filename> 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
<filename>basic_wal_module</filename> 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 <xref linkend="archive-modules"/>.
</para>
@ -21,15 +21,15 @@
must be enabled.
</para>
<sect2 id="basic-archive-configuration-parameters">
<sect2 id="basic-wal-module-configuration-parameters">
<title>Configuration Parameters</title>
<variablelist>
<varlistentry>
<term>
<varname>basic_archive.archive_directory</varname> (<type>string</type>)
<varname>basic_wal_module.archive_directory</varname> (<type>string</type>)
<indexterm>
<primary><varname>basic_archive.archive_directory</varname> configuration parameter</primary>
<primary><varname>basic_wal_module.archive_directory</varname> configuration parameter</primary>
</indexterm>
</term>
<listitem>
@ -52,12 +52,12 @@
<programlisting>
# postgresql.conf
archive_mode = 'on'
archive_library = 'basic_archive'
basic_archive.archive_directory = '/path/to/archive/directory'
archive_library = 'basic_wal_module'
basic_wal_module.archive_directory = '/path/to/archive/directory'
</programlisting>
</sect2>
<sect2 id="basic-archive-notes">
<sect2 id="basic-wal-module-notes">
<title>Notes</title>
<para>
@ -70,7 +70,7 @@ basic_archive.archive_directory = '/path/to/archive/directory'
</para>
</sect2>
<sect2 id="basic-archive-author">
<sect2 id="basic-wal-module-author">
<title>Author</title>
<para>

2
doc/src/sgml/contrib.sgml
View File

@ -105,7 +105,7 @@ CREATE EXTENSION <replaceable>extension_name</replaceable>;
&auth-delay;
&auto-explain;
&basebackup-to-shell;
&basic-archive;
&basic-wal-module;
&bloom;
&btree-gin;
&btree-gist;

3
doc/src/sgml/filelist.sgml
View File

@ -116,7 +116,7 @@
<!ENTITY amcheck SYSTEM "amcheck.sgml">
<!ENTITY auth-delay SYSTEM "auth-delay.sgml">
<!ENTITY auto-explain SYSTEM "auto-explain.sgml">
<!ENTITY basic-archive SYSTEM "basic-archive.sgml">
<!ENTITY basic-wal-module SYSTEM "basic-wal-module.sgml">
<!ENTITY basebackup-to-shell SYSTEM "basebackup-to-shell.sgml">
<!ENTITY bloom SYSTEM "bloom.sgml">
<!ENTITY btree-gin SYSTEM "btree-gin.sgml">
@ -200,3 +200,4 @@
<!ENTITY obsolete-pgxlogdump SYSTEM "appendix-obsolete-pgxlogdump.sgml">
<!ENTITY obsolete-pgresetxlog SYSTEM "appendix-obsolete-pgresetxlog.sgml">
<!ENTITY obsolete-pgreceivexlog SYSTEM "appendix-obsolete-pgreceivexlog.sgml">
<!ENTITY obsolete-basic-archive SYSTEM "appendix-obsolete-basic-archive.sgml">