Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit aede916

Browse files
author
Amit Kapila
committed
Doc: Add missing pgoutput options.
We forgot to update the docs while adding new options in pgoutput. Author: Emre Hasegeli Reviewed-by: Peter Smith, Amit Kapila Backpatch-through: 12 Discussion: https://postgr.es/m/CAE2gYzwdwtUbs-tPSV-QBwgTubiyGD2ZGsSnAVsDfAGGLDrGOA%40mail.gmail.com
1 parent 1771ec9 commit aede916

File tree

2 files changed

+16
-5
lines changed

2 files changed

+16
-5
lines changed

doc/src/sgml/logical-replication.sgml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,8 @@
432432
implemented by <quote>walsender</quote> and <quote>apply</quote>
433433
processes. The walsender process starts logical decoding (described
434434
in <xref linkend="logicaldecoding"/>) of the WAL and loads the standard
435-
logical decoding plugin (pgoutput). The plugin transforms the changes read
435+
logical decoding output plugin (<literal>pgoutput</literal>). The plugin
436+
transforms the changes read
436437
from WAL to the logical replication protocol
437438
(see <xref linkend="protocol-logical-replication"/>) and filters the data
438439
according to the publication specification. The data is then continuously

doc/src/sgml/protocol.sgml

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2515,7 +2515,10 @@ The commands accepted in replication mode are:
25152515
<term><replaceable class="parameter">option_name</replaceable></term>
25162516
<listitem>
25172517
<para>
2518-
The name of an option passed to the slot's logical decoding plugin.
2518+
The name of an option passed to the slot's logical decoding output
2519+
plugin. See <xref linkend="protocol-logical-replication"/> for
2520+
options that are accepted by the standard (<literal>pgoutput</literal>)
2521+
plugin.
25192522
</para>
25202523
</listitem>
25212524
</varlistentry>
@@ -2823,12 +2826,18 @@ The commands accepted in replication mode are:
28232826
the physical streaming replication protocol.
28242827
</para>
28252828

2829+
<para>
2830+
<productname>PostgreSQL</productname> logical decoding supports output
2831+
plugins. <literal>pgoutput</literal> is the standard one used for
2832+
the built-in logical replication.
2833+
</para>
2834+
28262835
<sect2 id="protocol-logical-replication-params">
28272836
<title>Logical Streaming Replication Parameters</title>
28282837

28292838
<para>
2830-
The logical replication <literal>START_REPLICATION</literal> command
2831-
accepts following parameters:
2839+
Using the <literal>START_REPLICATION</literal> command,
2840+
<literal>pgoutput</literal> accepts the following options:
28322841

28332842
<variablelist>
28342843
<varlistentry>
@@ -2838,7 +2847,7 @@ The commands accepted in replication mode are:
28382847
<listitem>
28392848
<para>
28402849
Protocol version. Currently only version <literal>1</literal> is
2841-
supported.
2850+
supported. A valid version is required.
28422851
</para>
28432852
</listitem>
28442853
</varlistentry>
@@ -2852,6 +2861,7 @@ The commands accepted in replication mode are:
28522861
Comma separated list of publication names for which to subscribe
28532862
(receive changes). The individual publication names are treated
28542863
as standard objects names and can be quoted the same as needed.
2864+
At least one publication name is required.
28552865
</para>
28562866
</listitem>
28572867
</varlistentry>

0 commit comments

Comments
 (0)