begriffs open source - ai-pg/blob - full-docs/txt/basic-archive.txt

   1
   2 F.5. basic_archive — an example WAL archive module #
   3
   4    F.5.1. Configuration Parameters
   5    F.5.2. Notes
   6    F.5.3. Author
   7
   8    basic_archive is an example of an archive module. This module copies
   9    completed WAL segment files to the specified directory. This may not be
  10    especially useful, but it can serve as a starting point for developing
  11    your own archive module. For more information about archive modules,
  12    see Chapter 49.
  13
  14    In order to function, this module must be loaded via archive_library,
  15    and archive_mode must be enabled.
  16
  17 F.5.1. Configuration Parameters #
  18
  19    basic_archive.archive_directory (string)
  20           The directory where the server should copy WAL segment files.
  21           This directory must already exist. The default is an empty
  22           string, which effectively halts WAL archiving, but if
  23           archive_mode is enabled, the server will accumulate WAL segment
  24           files in the expectation that a value will soon be provided.
  25
  26    These parameters must be set in postgresql.conf. Typical usage might
  27    be:
  28 # postgresql.conf
  29 archive_mode = 'on'
  30 archive_library = 'basic_archive'
  31 basic_archive.archive_directory = '/path/to/archive/directory'
  32
  33 F.5.2. Notes #
  34
  35    Server crashes may leave temporary files with the prefix archtemp in
  36    the archive directory. It is recommended to delete such files before
  37    restarting the server after a crash. It is safe to remove such files
  38    while the server is running as long as they are unrelated to any
  39    archiving still in progress, but users should use extra caution when
  40    doing so.
  41
  42 F.5.3. Author #
  43
  44    Nathan Bossart