database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-20 05:03:10 +03:00
Code Activity

doc: Fix confusing description of streaming option in START_REPLICATION.

Browse Source 
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
This commit is contained in:
Fujii Masao
2025-07-16 08:32:52 +09:00
parent 7c3b591af3
commit 09fcc652fe
1 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doc/src/sgml/protocol.sgml
View File

@ -3514,11 +3514,13 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
</term> </term>
<listitem> <listitem>
<para> <para>
Boolean option to enable streaming of in-progress transactions. Option to enable streaming of in-progress transactions. Valid values are
It accepts an additional value "parallel" to enable sending extra <literal>off</literal> (the default), <literal>on</literal> and
information with some messages to be used for parallelisation. <literal>parallel</literal>. The setting <literal>parallel</literal>
Minimum protocol version 2 is required to turn it on. Minimum protocol enables sending extra information with some messages to be used for
version 4 is required for the "parallel" option. parallelization. Minimum protocol version 2 is required to turn it
<literal>on</literal>. Minimum protocol version 4 is required for the
<literal>parallel</literal> value.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>