Skip to content

Commit 6cf5b10

Browse files
committed
doc: Document reopen of output file via SIGHUP in pg_recvlogical.
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
1 parent 226c567 commit 6cf5b10

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

doc/src/sgml/ref/pg_recvlogical.sgml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,16 @@ PostgreSQL documentation
5353
(<keycombo action="simul"><keycap>Control</keycap><keycap>C</keycap></keycombo>)
5454
or <systemitem>SIGTERM</systemitem> signal.
5555
</para>
56+
57+
<para>
58+
When <application>pg_recvlogical</application> receives
59+
a <systemitem>SIGHUP</systemitem> signal, it closes the current output file
60+
and opens a new one using the filename specified by
61+
the <option>--file</option> option. This allows us to rotate
62+
the output file by first renaming the current file and then sending
63+
a <systemitem>SIGHUP</systemitem> signal to
64+
<application>pg_recvlogical</application>.
65+
</para>
5666
</refsect1>
5767

5868
<refsect1>

0 commit comments

Comments
 (0)