doc: Clarify old WAL files are kept until they are summarized.
authorFujii Masao <fujii@postgresql.org>
Sun, 15 Dec 2024 02:18:18 +0000 (11:18 +0900)
committerFujii Masao <fujii@postgresql.org>
Sun, 15 Dec 2024 02:18:18 +0000 (11:18 +0900)
The documentation in wal.sgml explains that old WAL files cannot be
removed or recycled until they are archived (when WAL archiving is used)
or replicated (when using replication slots). However, it did not mention
that, similarly, old WAL files are also kept until they are summarized
if WAL summarization is enabled. This commit adds that clarification
to the documentation.

Back-patch to v17 where WAL summarization was added.

Author: Fujii Masao
Reviewed-by: Michael Paquier
Discussion: https://postgr.es/m/fd0eb0a5-f43b-4e06-b450-cbca011b6cff@oss.nttdata.com

doc/src/sgml/wal.sgml

index a34cddb5ed48e165e04da89ab7746e39bba3f468..b908720adea2656bea2ed77d1354447fe9160c80 100644 (file)
    until the situation is resolved. A slow or failed standby server that
    uses a replication slot will have the same effect (see
    <xref linkend="streaming-replication-slots"/>).
+   Similarly, if <link linkend="runtime-config-wal-summarization">
+   WAL summarization</link> is enabled, old segments are kept
+   until they are summarized.
   </para>
 
   <para>