Skip to content

Commit ba9201b

Browse files
committed
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 ac0e331, 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 <masao.fujii@gmail.com> Reviewed-by: Hayato Kuroda <kuroda.hayato@fujitsu.com> Reviewed-by: Nisha Moond <nisha.moond412@gmail.com> Discussion: https://postgr.es/m/78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com Backpatch-through: 16
1 parent 27224e6 commit ba9201b

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

doc/src/sgml/system-views.sgml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2482,20 +2482,18 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
24822482
<para>
24832483
<literal>unreserved</literal> means that the slot no longer
24842484
retains the required WAL files and some of them are to be removed at
2485-
the next checkpoint. This state can return
2485+
the next checkpoint. This typically occurs when
2486+
<xref linkend="guc-max-slot-wal-keep-size"/> is set to
2487+
a non-negative value. This state can return
24862488
to <literal>reserved</literal> or <literal>extended</literal>.
24872489
</para>
24882490
</listitem>
24892491
<listitem>
24902492
<para>
2491-
<literal>lost</literal> means that some required WAL files have
2492-
been removed and this slot is no longer usable.
2493+
<literal>lost</literal> means that this slot is no longer usable.
24932494
</para>
24942495
</listitem>
24952496
</itemizedlist>
2496-
The last two states are seen only when
2497-
<xref linkend="guc-max-slot-wal-keep-size"/> is
2498-
non-negative.
24992497
</para></entry>
25002498
</row>
25012499

0 commit comments

Comments
 (0)