Horton

Re: Mention idle_replication_slot_timeout in pg_replication_slots docs

Nisha Moond <nisha.moond412@gmail.com>

View thread View on postgr.es
From: Nisha Moond <nisha.moond412@gmail.com>
To: Fujii Masao <masao.fujii@oss.nttdata.com>
Cc: pgsql-docs@lists.postgresql.org
Date: 2025-06-26T06:46:06Z
Lists: pgsql-docs 
On Wed, Jun 25, 2025 at 9:56 PM Fujii Masao <masao.fujii@oss.nttdata.com> wrote:
>
> 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
>

+1 to the doc update.

> 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.
>

Since idle_replication_slot_timeout can only cause wal_status to
become 'lost' and not 'unreserved', perhaps we can reword the sentence
slightly for clarity, suggestion -
"The last two states are seen when max_slot_wal_keep_size is
non-negative and, the 'lost' state may also appear when
idle_replication_slot_timeout is greater than zero."

Please feel free to rephrase if needed.

--
Thanks,
Nisha

Commits

  1. doc: Update outdated descriptions of wal_status in pg_replication_slots.

  2. doc: Remove incorrect note about wal_status in pg_replication_slots.

  3. Invalidate inactive replication slots.

  4. Support invalidating replication slots due to horizon and wal_level