From 5e45211a64149b3c659b90ff2de6fa982a5a93ed Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sat, 4 May 2024 14:17:33 +0200 Subject: Adding upstream version 15.5. Signed-off-by: Daniel Baumann --- doc/src/sgml/html/basic-archive.html | 38 ++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 doc/src/sgml/html/basic-archive.html (limited to 'doc/src/sgml/html/basic-archive.html') diff --git a/doc/src/sgml/html/basic-archive.html b/doc/src/sgml/html/basic-archive.html new file mode 100644 index 0000000..a8b4081 --- /dev/null +++ b/doc/src/sgml/html/basic-archive.html @@ -0,0 +1,38 @@ + +F.6. basic_archive

F.6. 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 Chapter 51. +

+ In order to function, this module must be loaded via + archive_library, and archive_mode + must be enabled. +

F.6.1. Configuration Parameters

+ basic_archive.archive_directory (string) + +

+ 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 archive_mode + 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'
+

F.6.2. 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. +

F.6.3. Author

+ Nathan Bossart +

\ No newline at end of file -- cgit v1.2.3