Skip to content

Commit ac7c044

Browse files
committed
doc: Fix confusing description of streaming option in START_REPLICATION.
Previously, the documentation described the streaming option as a boolean, which is outdated since it's no longer a boolean as of protocol version 4. This could confuse users. This commit updates the description to remove the "boolean" reference and clearly list the valid values for the streaming option. Back-patch to v16, where the streaming option changed to a non-boolean. Author: Euler Taveira <euler@eulerto.com> Reviewed-by: Fujii Masao <masao.fujii@gmail.com> Discussion: https://postgr.es/m/8d21fb98-5c25-4dee-8387-e5a62b01ea7d@app.fastmail.com Backpatch-through: 16
1 parent da9a888 commit ac7c044

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

doc/src/sgml/protocol.sgml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3514,11 +3514,13 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
35143514
</term>
35153515
<listitem>
35163516
<para>
3517-
Boolean option to enable streaming of in-progress transactions.
3518-
It accepts an additional value "parallel" to enable sending extra
3519-
information with some messages to be used for parallelisation.
3520-
Minimum protocol version 2 is required to turn it on. Minimum protocol
3521-
version 4 is required for the "parallel" option.
3517+
Option to enable streaming of in-progress transactions. Valid values are
3518+
<literal>off</literal> (the default), <literal>on</literal> and
3519+
<literal>parallel</literal>. The setting <literal>parallel</literal>
3520+
enables sending extra information with some messages to be used for
3521+
parallelization. Minimum protocol version 2 is required to turn it
3522+
<literal>on</literal>. Minimum protocol version 4 is required for the
3523+
<literal>parallel</literal> value.
35223524
</para>
35233525
</listitem>
35243526
</varlistentry>

0 commit comments

Comments
 (0)