agora inbox for pgsql-docs@postgresql.org
help / color / mirror / Atom feedFrom: Fujii Masao <masao.fujii@oss.nttdata.com>
To: pgsql-docs@lists.postgresql.org
Subject: Mention idle_replication_slot_timeout in pg_replication_slots docs
Date: Thu, 26 Jun 2025 01:25:56 +0900
Message-ID: <78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com> (raw)
Hi,
The pg_replication_slots documentation mentions 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 has not been documented yet.
https://www.postgresql.org/docs/devel/view-pg-replication-slots.html
So, how about updating the documentation to also mention
idle_replication_slot_timeout as a factor that can cause wal_status to
become unreserved or lost? Patch attached.
Regards,
--
Fujii Masao
NTT DATA Japan Corporation
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
Attachments:
[text/plain] v1-0001-doc-Mention-idle_replication_slot_timeout-in-pg_r.patch (1.5K, ../78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com/2-v1-0001-doc-Mention-idle_replication_slot_timeout-in-pg_r.patch)
download | inline diff:
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
view thread (13+ messages) latest in thread
Message-ID: <78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com>
Permalink: ../78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com/
Also on: postgresql.org/message-id/78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com
reply
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-docs@postgresql.org
Cc: masao.fujii@oss.nttdata.com, pgsql-docs@lists.postgresql.org
Subject: Re: Mention idle_replication_slot_timeout in pg_replication_slots docs
In-Reply-To: <78b34e84-2195-4f28-a151-5d204a382fdd@oss.nttdata.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by agora; see mirroring instructions
for how to clone and mirror all data and code used for this inbox