From 0ad3c60caf5f77edfefaf8850fbba5ea4fe28640 Mon Sep 17 00:00:00 2001 From: Michael Paquier Date: Wed, 25 Jan 2023 14:36:51 +0900 Subject: Rename contrib module basic_archive to basic_wal_module 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 --- doc/src/sgml/appendix-obsolete-basic-archive.sgml | 25 +++++++ doc/src/sgml/appendix-obsolete.sgml | 1 + doc/src/sgml/archive-modules.sgml | 2 +- doc/src/sgml/basic-archive.sgml | 81 ----------------------- doc/src/sgml/basic-wal-module.sgml | 81 +++++++++++++++++++++++ doc/src/sgml/contrib.sgml | 2 +- doc/src/sgml/filelist.sgml | 3 +- 7 files changed, 111 insertions(+), 84 deletions(-) create mode 100644 doc/src/sgml/appendix-obsolete-basic-archive.sgml delete mode 100644 doc/src/sgml/basic-archive.sgml create mode 100644 doc/src/sgml/basic-wal-module.sgml (limited to 'doc/src') diff --git a/doc/src/sgml/appendix-obsolete-basic-archive.sgml b/doc/src/sgml/appendix-obsolete-basic-archive.sgml new file mode 100644 index 00000000000..5070b3b6abf --- /dev/null +++ b/doc/src/sgml/appendix-obsolete-basic-archive.sgml @@ -0,0 +1,25 @@ + + + + + <command>basic_archive</command> renamed to <command>basic_wal_module</command> + + + basic_archive + basic_wal_module + + + + PostgreSQL 15 provided an archive module named + basic_archive + basic_archive. + This module was renamed to basic_wal_module. See + for documentation of + basic_wal_module, and see + the release notes for PostgreSQL 16 + for details on this change. + + + diff --git a/doc/src/sgml/appendix-obsolete.sgml b/doc/src/sgml/appendix-obsolete.sgml index b1a00c8ce67..87c1b1020df 100644 --- a/doc/src/sgml/appendix-obsolete.sgml +++ b/doc/src/sgml/appendix-obsolete.sgml @@ -38,5 +38,6 @@ &obsolete-pgxlogdump; &obsolete-pgresetxlog; &obsolete-pgreceivexlog; + &obsolete-basic-archive; diff --git a/doc/src/sgml/archive-modules.sgml b/doc/src/sgml/archive-modules.sgml index ef02051f7f0..1a32006e2c7 100644 --- a/doc/src/sgml/archive-modules.sgml +++ b/doc/src/sgml/archive-modules.sgml @@ -32,7 +32,7 @@ - The contrib/basic_archive module contains a working + The contrib/basic_wal_module module contains a working example, which demonstrates some useful techniques. diff --git a/doc/src/sgml/basic-archive.sgml b/doc/src/sgml/basic-archive.sgml deleted file mode 100644 index b4d43ced203..00000000000 --- a/doc/src/sgml/basic-archive.sgml +++ /dev/null @@ -1,81 +0,0 @@ - - - - basic_archive — an example WAL archive module - - - basic_archive - - - - basic_archive 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 . - - - - In order to function, this module must be loaded via - , and - must be enabled. - - - - Configuration Parameters - - - - - basic_archive.archive_directory (string) - - basic_archive.archive_directory configuration parameter - - - - - 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 - is enabled, the server will accumulate WAL segment files in the - expectation that a value will soon be provided. - - - - - - - These parameters must be set in postgresql.conf. - Typical usage might be: - - - -# postgresql.conf -archive_mode = 'on' -archive_library = 'basic_archive' -basic_archive.archive_directory = '/path/to/archive/directory' - - - - - Notes - - - Server crashes may leave temporary files with the prefix - archtemp 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. - - - - - Author - - - Nathan Bossart - - - - diff --git a/doc/src/sgml/basic-wal-module.sgml b/doc/src/sgml/basic-wal-module.sgml new file mode 100644 index 00000000000..c418b01eb85 --- /dev/null +++ b/doc/src/sgml/basic-wal-module.sgml @@ -0,0 +1,81 @@ + + + + basic_wal_module — an example write-ahead log module + + + basic_wal_module + + + + basic_wal_module 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 . + + + + In order to function, this module must be loaded via + , and + must be enabled. + + + + Configuration Parameters + + + + + basic_wal_module.archive_directory (string) + + basic_wal_module.archive_directory configuration parameter + + + + + 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 + is enabled, the server will accumulate WAL segment files in the + expectation that a value will soon be provided. + + + + + + + These parameters must be set in postgresql.conf. + Typical usage might be: + + + +# postgresql.conf +archive_mode = 'on' +archive_library = 'basic_wal_module' +basic_wal_module.archive_directory = '/path/to/archive/directory' + + + + + Notes + + + Server crashes may leave temporary files with the prefix + archtemp 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. + + + + + Author + + + Nathan Bossart + + + + diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 12c79b798ba..3225284eead 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -105,7 +105,7 @@ CREATE EXTENSION extension_name; &auth-delay; &auto-explain; &basebackup-to-shell; - &basic-archive; + &basic-wal-module; &bloom; &btree-gin; &btree-gist; diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 0d6be9a2faf..2d36c34ce81 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -116,7 +116,7 @@ - + @@ -200,3 +200,4 @@ + -- cgit v1.2.3