doc: Clarify meaning of "idle" in idle_replication_slot_timeout.
authorFujii Masao <[email protected]>
Thu, 10 Jul 2025 23:44:32 +0000 (08:44 +0900)
committerFujii Masao <[email protected]>
Thu, 10 Jul 2025 23:44:32 +0000 (08:44 +0900)
commit110e6dcaa6595cf71be00808e3df0087d1d2b208
treee965efd48d673663524717f50689d848b06643e4
parent05dedf43d380edc98546c381e76a9d907fd19bed
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 <[email protected]>
Reviewed-by: David G. Johnston <[email protected]>
Reviewed-by: Gunnar Morling <[email protected]>
Reviewed-by: Amit Kapila <[email protected]>
Reviewed-by: Fujii Masao <[email protected]>
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