begriffs open source - ai-pg/blob - full-docs/txt/app-pgwalsummary.txt

   1
   2 pg_walsummary
   3
   4    pg_walsummary — print contents of WAL summary files
   5
   6 Synopsis
   7
   8    pg_walsummary [option...] [file...]
   9
  10 Description
  11
  12    pg_walsummary is used to print the contents of WAL summary files. These
  13    binary files are found with the pg_wal/summaries subdirectory of the
  14    data directory, and can be converted to text using this tool. This is
  15    not ordinarily necessary, since WAL summary files primarily exist to
  16    support incremental backup, but it may be useful for debugging
  17    purposes.
  18
  19    A WAL summary file is indexed by tablespace OID, relation OID, and
  20    relation fork. For each relation fork, it stores the list of blocks
  21    that were modified by WAL within the range summarized in the file. It
  22    can also store a "limit block," which is 0 if the relation fork was
  23    created or truncated within the relevant WAL range, and otherwise the
  24    shortest length to which the relation fork was truncated. If the
  25    relation fork was not created, deleted, or truncated within the
  26    relevant WAL range, the limit block is undefined or infinite and will
  27    not be printed by this tool.
  28
  29 Options
  30
  31    -i
  32           --individual
  33           By default, pg_walsummary prints one line of output for each
  34           range of one or more consecutive modified blocks. This can make
  35           the output a lot briefer, since a relation where all blocks from
  36           0 through 999 were modified will produce only one line of output
  37           rather than 1000 separate lines. This option requests a separate
  38           line of output for every modified block.
  39
  40    -q
  41           --quiet
  42           Do not print any output, except for errors. This can be useful
  43           when you want to know whether a WAL summary file can be
  44           successfully parsed but don't care about the contents.
  45
  46    -V
  47           --version
  48           Display version information, then exit.
  49
  50    -?
  51           --help
  52           Shows help about pg_walsummary command line arguments, and
  53           exits.
  54
  55 Environment
  56
  57    The environment variable PG_COLOR specifies whether to use color in
  58    diagnostic messages. Possible values are always, auto and never.
  59
  60 See Also
  61
  62    pg_basebackup, pg_combinebackup