@@ -2541,7 +2541,10 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
2541
2541
<term><replaceable class="parameter">option_name</replaceable></term>
2542
2542
<listitem>
2543
2543
<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.
2545
2548
</para>
2546
2549
</listitem>
2547
2550
</varlistentry>
@@ -3078,12 +3081,18 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
3078
3081
the physical streaming replication protocol.
3079
3082
</para>
3080
3083
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
+
3081
3090
<sect2 id="protocol-logical-replication-params">
3082
3091
<title>Logical Streaming Replication Parameters</title>
3083
3092
3084
3093
<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 :
3087
3096
3088
3097
<variablelist>
3089
3098
<varlistentry>
@@ -3093,7 +3102,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
3093
3102
<listitem>
3094
3103
<para>
3095
3104
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.
3097
3107
</para>
3098
3108
<para>
3099
3109
Version <literal>2</literal> is supported only for server version 14
@@ -3120,6 +3130,73 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
3120
3130
Comma separated list of publication names for which to subscribe
3121
3131
(receive changes). The individual publication names are treated
3122
3132
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.
3123
3200
</para>
3124
3201
</listitem>
3125
3202
</varlistentry>
0 commit comments