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

Commit 06bbe73

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 11652f9 commit 06bbe73

File tree

2 files changed

+84
-6
lines changed

2 files changed

+84
-6
lines changed

doc/src/sgml/logical-replication.sgml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -532,7 +532,7 @@ test_sub=# SELECT * FROM t3;
532532
remote replication slot was not created automatically, the user must create
533533
it manually before the subscription can be activated. The steps to create
534534
the slot and activate the subscription are shown in the following examples.
535-
These examples specify the standard logical decoding plugin
535+
These examples specify the standard logical decoding output plugin
536536
(<literal>pgoutput</literal>), which is what the built-in logical
537537
replication uses.
538538
</para>
@@ -1643,7 +1643,8 @@ CONTEXT: processing remote data for replication origin "pg_16395" during "INSER
16431643
implemented by <literal>walsender</literal> and <literal>apply</literal>
16441644
processes. The walsender process starts logical decoding (described
16451645
in <xref linkend="logicaldecoding"/>) of the WAL and loads the standard
1646-
logical decoding plugin (pgoutput). The plugin transforms the changes read
1646+
logical decoding output plugin (<literal>pgoutput</literal>). The plugin
1647+
transforms the changes read
16471648
from WAL to the logical replication protocol
16481649
(see <xref linkend="protocol-logical-replication"/>) and filters the data
16491650
according to the publication specification. The data is then continuously

doc/src/sgml/protocol.sgml

Lines changed: 81 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2541,7 +2541,10 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
25412541
<term><replaceable class="parameter">option_name</replaceable></term>
25422542
<listitem>
25432543
<para>
2544-
The name of an option passed to the slot's logical decoding plugin.
2544+
The name of an option passed to the slot's logical decoding output
2545+
plugin. See <xref linkend="protocol-logical-replication"/> for
2546+
options that are accepted by the standard (<literal>pgoutput</literal>)
2547+
plugin.
25452548
</para>
25462549
</listitem>
25472550
</varlistentry>
@@ -3078,12 +3081,18 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
30783081
the physical streaming replication protocol.
30793082
</para>
30803083

3084+
<para>
3085+
<productname>PostgreSQL</productname> logical decoding supports output
3086+
plugins. <literal>pgoutput</literal> is the standard one used for
3087+
the built-in logical replication.
3088+
</para>
3089+
30813090
<sect2 id="protocol-logical-replication-params">
30823091
<title>Logical Streaming Replication Parameters</title>
30833092

30843093
<para>
3085-
The logical replication <literal>START_REPLICATION</literal> command
3086-
accepts following parameters:
3094+
Using the <literal>START_REPLICATION</literal> command,
3095+
<literal>pgoutput</literal> accepts the following options:
30873096

30883097
<variablelist>
30893098
<varlistentry>
@@ -3093,7 +3102,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
30933102
<listitem>
30943103
<para>
30953104
Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,
3096-
<literal>3</literal>, and <literal>4</literal> are supported.
3105+
<literal>3</literal>, and <literal>4</literal> are supported. A valid
3106+
version is required.
30973107
</para>
30983108
<para>
30993109
Version <literal>2</literal> is supported only for server version 14
@@ -3120,6 +3130,73 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
31203130
Comma separated list of publication names for which to subscribe
31213131
(receive changes). The individual publication names are treated
31223132
as standard objects names and can be quoted the same as needed.
3133+
At least one publication name is required.
3134+
</para>
3135+
</listitem>
3136+
</varlistentry>
3137+
3138+
<varlistentry>
3139+
<term>
3140+
binary
3141+
</term>
3142+
<listitem>
3143+
<para>
3144+
Boolean option to use binary transfer mode. Binary mode is faster
3145+
than the text mode but slightly less robust.
3146+
</para>
3147+
</listitem>
3148+
</varlistentry>
3149+
3150+
<varlistentry>
3151+
<term>
3152+
messages
3153+
</term>
3154+
<listitem>
3155+
<para>
3156+
Boolean option to enable sending the messages that are written
3157+
by <function>pg_logical_emit_message</function>.
3158+
</para>
3159+
</listitem>
3160+
</varlistentry>
3161+
3162+
<varlistentry>
3163+
<term>
3164+
streaming
3165+
</term>
3166+
<listitem>
3167+
<para>
3168+
Boolean option to enable streaming of in-progress transactions.
3169+
It accepts an additional value "parallel" to enable sending extra
3170+
information with some messages to be used for parallelisation.
3171+
Minimum protocol version 2 is required to turn it on. Minimum protocol
3172+
version 4 is required for the "parallel" option.
3173+
</para>
3174+
</listitem>
3175+
</varlistentry>
3176+
3177+
<varlistentry>
3178+
<term>
3179+
two_phase
3180+
</term>
3181+
<listitem>
3182+
<para>
3183+
Boolean option to enable two-phase transactions. Minimum protocol
3184+
version 3 is required to turn it on.
3185+
</para>
3186+
</listitem>
3187+
</varlistentry>
3188+
3189+
<varlistentry>
3190+
<term>
3191+
origin
3192+
</term>
3193+
<listitem>
3194+
<para>
3195+
Option to send changes by their origin. Possible values are "none"
3196+
to only send the changes that have no origin associated, or "any"
3197+
to send the changes regardless of their origin. This can be used
3198+
to avoid loops (infinite replication of the same data) among
3199+
replication nodes.
31233200
</para>
31243201
</listitem>
31253202
</varlistentry>

0 commit comments

Comments
 (0)