doc: Clarify meaning of "idle" in idle_replication_slot_timeout.
authorFujii Masao <fujii@postgresql.org>
Thu, 10 Jul 2025 23:44:32 +0000 (08:44 +0900)
committerFujii Masao <fujii@postgresql.org>
Thu, 10 Jul 2025 23:45:56 +0000 (08:45 +0900)
commitafb64a56d9c13d0bcd32c00e9a4482106217ed96
treec58317c2d7b7eb7efa417a103a6024f3e9eceaeb
parent37c76aeb9ae30f3fee6ee86f54344670c7099d9c
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.albe@cybertec.at>
Reviewed-by: David G. Johnston <david.g.johnston@gmail.com>
Reviewed-by: Gunnar Morling <gunnar.morling@googlemail.com>
Reviewed-by: Amit Kapila <amit.kapila16@gmail.com>
Reviewed-by: Fujii Masao <masao.fujii@gmail.com>
Discussion: https://postgr.es/m/CADGJaX_0+FTguWpNSpgVWYQP_7MhoO0D8=cp4XozSQgaZ40Odw@mail.gmail.com
Backpatch-through: 18
doc/src/sgml/config.sgml
doc/src/sgml/system-views.sgml
src/backend/replication/slot.c