summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFujii Masao2025-07-20 03:00:46 +0000
committerFujii Masao2025-07-20 03:01:31 +0000
commit7efaf0a1b3e2ce58f4e4cddaa9afe6a60a978bcf (patch)
tree1eeda45bf857087b61ebfe928aad82684c258200 /doc
parentbedfdb85b0a344c84b04c234339075d676b7b608 (diff)
doc: Document reopen of output file via SIGHUP in pg_recvlogical.REL_14_STABLE
When pg_recvlogical receives a SIGHUP signal, it closes the current output file and reopens a new one. This is useful since it allows us to rotate the output file by renaming the current file and sending a SIGHUP. This behavior was previously undocumented. This commit adds the missing documentation. Back-patch to all supported versions. Author: Fujii Masao <masao.fujii@gmail.com> Reviewed-by: Shinya Kato <shinya11.kato@gmail.com> Discussion: https://postgr.es/m/0977fc4f-1523-4ecd-8a0e-391af4976367@oss.nttdata.com Backpatch-through: 13
Diffstat (limited to 'doc')
-rw-r--r--doc/src/sgml/ref/pg_recvlogical.sgml10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
index 6b1d98d06ef..e4b3955edca 100644
--- a/doc/src/sgml/ref/pg_recvlogical.sgml
+++ b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -46,6 +46,16 @@ PostgreSQL documentation
a slot without consuming it, use
<link linkend="functions-replication"><function>pg_logical_slot_peek_changes</function></link>.
</para>
+
+ <para>
+ When <application>pg_recvlogical</application> receives
+ a <systemitem>SIGHUP</systemitem> signal, it closes the current output file
+ and opens a new one using the filename specified by
+ the <option>--file</option> option. This allows us to rotate
+ the output file by first renaming the current file and then sending
+ a <systemitem>SIGHUP</systemitem> signal to
+ <application>pg_recvlogical</application>.
+ </para>
</refsect1>
<refsect1>