pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout.

From: Fujii Masao <fujii(at)postgresql(dot)org>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout.
Date: 2025-07-10 23:46:30
Message-ID: E1ua0yD-005fEz-2l@gemulon.postgresql.org
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-committers

doc: Clarify meaning of "idle" in idle_replication_slot_timeout.

This commit updates the documentation to clarify that "idle" in
idle_replication_slot_timeout means the replication slot is inactive,
that is, not currently used by any replication connection.

Without this clarification, "idle" could be misinterpreted to mean
that the slot is not advancing or that no data is being streamed,
even if a connection exists.

Back-patch to v18 where idle_replication_slot_timeout was added.

Author: Laurenz Albe <laurenz(dot)albe(at)cybertec(dot)at>
Reviewed-by: David G. Johnston <david(dot)g(dot)johnston(at)gmail(dot)com>
Reviewed-by: Gunnar Morling <gunnar(dot)morling(at)googlemail(dot)com>
Reviewed-by: Amit Kapila <amit(dot)kapila16(at)gmail(dot)com>
Reviewed-by: Fujii Masao <masao(dot)fujii(at)gmail(dot)com>
Discussion: https://postgr.es/m/CADGJaX_0+FTguWpNSpgVWYQP_7MhoO0D8=cp4XozSQgaZ40Odw@mail.gmail.com
Backpatch-through: 18

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/110e6dcaa6595cf71be00808e3df0087d1d2b208

Modified Files
--------------
doc/src/sgml/config.sgml | 10 ++++++----
doc/src/sgml/system-views.sgml | 2 +-
src/backend/replication/slot.c | 2 +-
3 files changed, 8 insertions(+), 6 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Fujii Masao 2025-07-10 23:46:42 pgsql: doc: Clarify meaning of "idle" in idle_replication_slot_timeout.
Previous Message Fujii Masao 2025-07-10 23:44:03 pgsql: Change unit of idle_replication_slot_timeout to seconds.