database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

doc: Clarify meaning of "idle" in idle_replication_slot_timeout.

Browse Source 
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
This commit is contained in:
Fujii Masao
2025-07-11 08:44:32 +09:00
parent 05dedf43d3
commit 110e6dcaa6
3 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
doc/src/sgml/config.sgml
View File

@ -4618,10 +4618,12 @@ restore_command = 'copy "C:\\server\\archivedir\\%f" "%p"' # Windows
</term> </term>
<listitem> <listitem>
<para> <para>
Invalidate replication slots that have remained idle longer than this Invalidate replication slots that have remained inactive (not used by
duration. If this value is specified without units, it is taken as a <link linkend="protocol-replication">replication connection</link>)
seconds. A value of zero (the default) disables the idle timeout for longer than this duration.
invalidation mechanism. This parameter can only be set in the If this value is specified without units, it is taken as seconds.
A value of zero (the default) disables the idle timeout
invalidation mechanism. This parameter can only be set in the
<filename>postgresql.conf</filename> file or on the server command <filename>postgresql.conf</filename> file or on the server command
line. line.
</para> </para>

2
doc/src/sgml/system-views.sgml
View File

@ -3003,7 +3003,7 @@ SELECT * FROM pg_locks pl LEFT JOIN pg_prepared_xacts ppx
<listitem> <listitem>
<para> <para>
<literal>idle_timeout</literal> means that the slot has remained <literal>idle_timeout</literal> means that the slot has remained
idle longer than the configured inactive longer than the configured
<xref linkend="guc-idle-replication-slot-timeout"/> duration. <xref linkend="guc-idle-replication-slot-timeout"/> duration.
</para> </para>
</listitem> </listitem>

2
src/backend/replication/slot.c
View File

@ -1892,7 +1892,7 @@ InvalidatePossiblyObsoleteSlot(uint32 possible_causes,
* max_slot_wal_keep_size is set to -1 and * max_slot_wal_keep_size is set to -1 and
* idle_replication_slot_timeout is set to 0 during the binary * idle_replication_slot_timeout is set to 0 during the binary
* upgrade. See check_old_cluster_for_valid_slots() where we ensure * upgrade. See check_old_cluster_for_valid_slots() where we ensure
* that no invalidated before the upgrade. * that no slot was invalidated before the upgrade.
*/ */
Assert(!(*invalidated && SlotIsLogical(s) && IsBinaryUpgrade)); Assert(!(*invalidated && SlotIsLogical(s) && IsBinaryUpgrade));