summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFujii Masao2025-07-03 14:07:23 +0000
committerFujii Masao2025-07-03 14:09:14 +0000
commitba9201b57b00b8f9a612a3fd1ae22a768556cb3d (patch)
tree9cfe03899d9491773f0fd71d11fd5fb7bc7110d0
parent27224e660aca7704e565ff6d7fc1c8f262c2f05c (diff)
doc: Update outdated descriptions of wal_status in pg_replication_slots.
The documentation for pg_replication_slots previously mentioned only max_slot_wal_keep_size as a condition under which the wal_status column could show unreserved or lost. However, since commit be87200, replication slots can also be invalidated due to horizon or wal_level, and since commit ac0e33136ab, idle_replication_slot_timeout can also trigger this state. This commit updates the description of the wal_status column to reflect that max_slot_wal_keep_size is not the only cause of the lost state. Back-patched to v16, where the additional invalidation cases were introduced. Author: Fujii Masao <[email protected]> Reviewed-by: Hayato Kuroda <[email protected]> Reviewed-by: Nisha Moond <[email protected]> Discussion: https://postgr.es/m/[email protected] Backpatch-through: 16
-rw-r--r--doc/src/sgml/system-views.sgml10
1 files changed, 4 insertions, 6 deletions
diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml
index 7b36190145a..560e95caec4 100644
--- a/doc/src/sgml/system-views.sgml
+++ b/doc/src/sgml/system-views.sgml
@@ -2482,20 +2482,18 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<para>
<literal>unreserved</literal> means that the slot no longer
retains the required WAL files and some of them are to be removed at
- the next checkpoint. This state can return
+ the next checkpoint. This typically occurs when
+ <xref linkend="guc-max-slot-wal-keep-size"/> is set to
+ a non-negative value. This state can return
to <literal>reserved</literal> or <literal>extended</literal>.
</para>
</listitem>
<listitem>
<para>
- <literal>lost</literal> means that some required WAL files have
- been removed and this slot is no longer usable.
+ <literal>lost</literal> means that this slot is no longer usable.
</para>
</listitem>
</itemizedlist>
- The last two states are seen only when
- <xref linkend="guc-max-slot-wal-keep-size"/> is
- non-negative.
</para></entry>
</row>