@@ -2545,7 +2545,10 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
25452545 <term><replaceable class="parameter">option_name</replaceable></term>
25462546 <listitem>
25472547 <para>
2548- The name of an option passed to the slot's logical decoding plugin.
2548+ The name of an option passed to the slot's logical decoding output
2549+ plugin. See <xref linkend="protocol-logical-replication"/> for
2550+ options that are accepted by the standard (<literal>pgoutput</literal>)
2551+ plugin.
25492552 </para>
25502553 </listitem>
25512554 </varlistentry>
@@ -3106,12 +3109,18 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
31063109 the physical streaming replication protocol.
31073110 </para>
31083111
3112+ <para>
3113+ <productname>PostgreSQL</productname> logical decoding supports output
3114+ plugins. <literal>pgoutput</literal> is the standard one used for
3115+ the built-in logical replication.
3116+ </para>
3117+
31093118 <sect2 id="protocol-logical-replication-params">
31103119 <title>Logical Streaming Replication Parameters</title>
31113120
31123121 <para>
3113- The logical replication <literal>START_REPLICATION</literal> command
3114- accepts following parameters :
3122+ Using the <literal>START_REPLICATION</literal> command,
3123+ <literal>pgoutput</literal> accepts the following options :
31153124
31163125 <variablelist>
31173126 <varlistentry>
@@ -3121,7 +3130,8 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
31213130 <listitem>
31223131 <para>
31233132 Protocol version. Currently versions <literal>1</literal>, <literal>2</literal>,
3124- <literal>3</literal>, and <literal>4</literal> are supported.
3133+ <literal>3</literal>, and <literal>4</literal> are supported. A valid
3134+ version is required.
31253135 </para>
31263136 <para>
31273137 Version <literal>2</literal> is supported only for server version 14
@@ -3148,6 +3158,73 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
31483158 Comma separated list of publication names for which to subscribe
31493159 (receive changes). The individual publication names are treated
31503160 as standard objects names and can be quoted the same as needed.
3161+ At least one publication name is required.
3162+ </para>
3163+ </listitem>
3164+ </varlistentry>
3165+
3166+ <varlistentry>
3167+ <term>
3168+ binary
3169+ </term>
3170+ <listitem>
3171+ <para>
3172+ Boolean option to use binary transfer mode. Binary mode is faster
3173+ than the text mode but slightly less robust.
3174+ </para>
3175+ </listitem>
3176+ </varlistentry>
3177+
3178+ <varlistentry>
3179+ <term>
3180+ messages
3181+ </term>
3182+ <listitem>
3183+ <para>
3184+ Boolean option to enable sending the messages that are written
3185+ by <function>pg_logical_emit_message</function>.
3186+ </para>
3187+ </listitem>
3188+ </varlistentry>
3189+
3190+ <varlistentry>
3191+ <term>
3192+ streaming
3193+ </term>
3194+ <listitem>
3195+ <para>
3196+ Boolean option to enable streaming of in-progress transactions.
3197+ It accepts an additional value "parallel" to enable sending extra
3198+ information with some messages to be used for parallelisation.
3199+ Minimum protocol version 2 is required to turn it on. Minimum protocol
3200+ version 4 is required for the "parallel" option.
3201+ </para>
3202+ </listitem>
3203+ </varlistentry>
3204+
3205+ <varlistentry>
3206+ <term>
3207+ two_phase
3208+ </term>
3209+ <listitem>
3210+ <para>
3211+ Boolean option to enable two-phase transactions. Minimum protocol
3212+ version 3 is required to turn it on.
3213+ </para>
3214+ </listitem>
3215+ </varlistentry>
3216+
3217+ <varlistentry>
3218+ <term>
3219+ origin
3220+ </term>
3221+ <listitem>
3222+ <para>
3223+ Option to send changes by their origin. Possible values are "none"
3224+ to only send the changes that have no origin associated, or "any"
3225+ to send the changes regardless of their origin. This can be used
3226+ to avoid loops (infinite replication of the same data) among
3227+ replication nodes.
31513228 </para>
31523229 </listitem>
31533230 </varlistentry>
0 commit comments