Skip to content

Commit 5c8758e

Browse files
committed
doc: Clean up pg_recvlogical reference page
This needed a general cleanup of wording, typos, outdated terminology, formatting, and hard-to-understand and borderline incorrect information. Also tweak the pg_receivexlog page a bit to make the two more consistent.
1 parent b45f048 commit 5c8758e

File tree

2 files changed

+220
-197
lines changed

2 files changed

+220
-197
lines changed

doc/src/sgml/ref/pg_receivexlog.sgml

Lines changed: 34 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ PostgreSQL documentation
1616

1717
<refnamediv>
1818
<refname>pg_receivexlog</refname>
19-
<refpurpose>streams transaction logs from a <productname>PostgreSQL</productname> cluster</refpurpose>
19+
<refpurpose>stream transaction logs from a <productname>PostgreSQL</productname> server</refpurpose>
2020
</refnamediv>
2121

2222
<refsynopsisdiv>
@@ -71,10 +71,6 @@ PostgreSQL documentation
7171
<refsect1>
7272
<title>Options</title>
7373

74-
<para>
75-
The following command-line options control the location and format of the
76-
output.
77-
7874
<variablelist>
7975
<varlistentry>
8076
<term><option>-D <replaceable class="parameter">directory</replaceable></option></term>
@@ -88,12 +84,7 @@ PostgreSQL documentation
8884
</para>
8985
</listitem>
9086
</varlistentry>
91-
</variablelist>
92-
</para>
93-
<para>
94-
The following command-line options control the running of the program.
9587

96-
<variablelist>
9788
<varlistentry>
9889
<term><option>-n</option></term>
9990
<term><option>--no-loop</option></term>
@@ -105,6 +96,39 @@ PostgreSQL documentation
10596
</listitem>
10697
</varlistentry>
10798

99+
<varlistentry>
100+
<term><option>-s <replaceable class="parameter">interval</replaceable></option></term>
101+
<term><option>--status-interval=<replaceable class="parameter">interval</replaceable></option></term>
102+
<listitem>
103+
<para>
104+
Specifies the number of seconds between status packets sent back to the
105+
server. This allows for easier monitoring of the progress from server.
106+
A value of zero disables the periodic status updates completely,
107+
although an update will still be sent when requested by the server, to
108+
avoid timeout disconnect. The default value is 10 seconds.
109+
</para>
110+
</listitem>
111+
</varlistentry>
112+
113+
<varlistentry>
114+
<term><option>-S <replaceable>slotname</replaceable></option></term>
115+
<term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
116+
<listitem>
117+
<para>
118+
Require <application>pg_receivexlog</application> to use an existing
119+
replication slot (see <xref linkend="streaming-replication-slots">).
120+
When this option is used, <application>pg_receivexlog</> will report
121+
a flush position to the server, indicating when each segment has been
122+
synchronized to disk so that the server can remove that segment if it
123+
is not otherwise needed. When using this parameter, it is important
124+
to make sure that <application>pg_receivexlog</> cannot become the
125+
synchronous standby through an incautious setting of
126+
<xref linkend="guc-synchronous-standby-names">; it does not flush
127+
data frequently enough for this to work correctly.
128+
</para>
129+
</listitem>
130+
</varlistentry>
131+
108132
<varlistentry>
109133
<term><option>-v</option></term>
110134
<term><option>--verbose</option></term>
@@ -114,9 +138,7 @@ PostgreSQL documentation
114138
</para>
115139
</listitem>
116140
</varlistentry>
117-
118141
</variablelist>
119-
</para>
120142

121143
<para>
122144
The following command-line options control the database connection parameters.
@@ -166,20 +188,6 @@ PostgreSQL documentation
166188
</listitem>
167189
</varlistentry>
168190

169-
<varlistentry>
170-
<term><option>-s <replaceable class="parameter">interval</replaceable></option></term>
171-
<term><option>--status-interval=<replaceable class="parameter">interval</replaceable></option></term>
172-
<listitem>
173-
<para>
174-
Specifies the number of seconds between status packets sent back to the
175-
server. This allows for easier monitoring of the progress from server.
176-
A value of zero disables the periodic status updates completely,
177-
although an update will still be sent when requested by the server, to
178-
avoid timeout disconnect. The default value is 10 seconds.
179-
</para>
180-
</listitem>
181-
</varlistentry>
182-
183191
<varlistentry>
184192
<term><option>-U <replaceable>username</replaceable></option></term>
185193
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
@@ -225,25 +233,6 @@ PostgreSQL documentation
225233
</para>
226234
</listitem>
227235
</varlistentry>
228-
229-
<varlistentry>
230-
<term><option>-S <replaceable>slotname</replaceable></option></term>
231-
<term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
232-
<listitem>
233-
<para>
234-
Require <application>pg_receivexlog</application> to use an existing
235-
replication slot (see <xref linkend="streaming-replication-slots">).
236-
When this option is used, <application>pg_receivexlog</> will report
237-
a flush position to the server, indicating when each segment has been
238-
synchronized to disk so that the server can remove that segment if it
239-
is not otherwise needed. When using this parameter, it is important
240-
to make sure that <application>pg_receivexlog</> cannot become the
241-
synchronous standby through an incautious setting of
242-
<xref linkend="guc-synchronous-standby-names">; it does not flush
243-
data frequently enough for this to work correctly.
244-
</para>
245-
</listitem>
246-
</varlistentry>
247236
</variablelist>
248237
</para>
249238

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy