v1-0001-doc-Mention-idle_replication_slot_timeout-in-pg_r.patch
text/plain
Filename: v1-0001-doc-Mention-idle_replication_slot_timeout-in-pg_r.patch
Type: text/plain
Part: 0
Patch
Format: format-patch
Series: patch v1-0001
Subject: doc: Mention idle_replication_slot_timeout in pg_replication_slots docs.
| File | + | − |
|---|---|---|
| doc/src/sgml/system-views.sgml | 3 | 2 |
From 7bccb16c1119e00194939dfe154d1aa0e8d19842 Mon Sep 17 00:00:00 2001
From: Fujii Masao <fujii@postgresql.org>
Date: Thu, 26 Jun 2025 00:55:46 +0900
Subject: [PATCH v1] doc: Mention idle_replication_slot_timeout in
pg_replication_slots docs.
The pg_replication_slots documentation previously mentioned only
max_slot_wal_keep_size as a condition under which the wal_status column
can show unreserved or lost. However, since commit ac0e33136ab,
idle_replication_slot_timeout can also cause this behavior when it is set.
This was not documented.
This commit updates the documentation to also mention
idle_replication_slot_timeout as a factor that can cause wal_status
to become unreserved or lost.
---
doc/src/sgml/system-views.sgml | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/doc/src/sgml/system-views.sgml b/doc/src/sgml/system-views.sgml
index 986ae1f543d..f97da9f7e61 100644
--- a/doc/src/sgml/system-views.sgml
+++ b/doc/src/sgml/system-views.sgml
@@ -2832,8 +2832,9 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
</itemizedlist>
The last two states are seen only when
<xref linkend="guc-max-slot-wal-keep-size"/> is
- non-negative. If <structfield>restart_lsn</structfield> is NULL, this
- field is null.
+ non-negative and/or <xref linkend="guc-idle-replication-slot-timeout"/>
+ is greater than zero. If <structfield>restart_lsn</structfield> is NULL,
+ this field is null.
</para></entry>
</row>
--
2.49.0