doc: Document default values for pgoutput options in protocol.sgml.
authorFujii Masao <fujii@postgresql.org>
Tue, 15 Jul 2025 23:51:04 +0000 (08:51 +0900)
committerFujii Masao <fujii@postgresql.org>
Tue, 15 Jul 2025 23:51:04 +0000 (08:51 +0900)
The pgoutput plugin options are described in the logical streaming
replication protocol documentation, but their default values were
previously not mentioned. This made it less convenient for users,
for example, when specifying those options to use pg_recvlogical
with pgoutput plugin.

This commit adds the explanations of the default values for pgoutput
options to improve clarity and usability.

Author: Fujii Masao <masao.fujii@gmail.com>
Reviewed-by: Euler Taveira <euler@eulerto.com>
Reviewed-by: Amit Kapila <amit.kapila16@gmail.com>
Discussion: https://postgr.es/m/d2790f10-238d-4cb5-a743-d9d2a9dd900f@oss.nttdata.com

doc/src/sgml/protocol.sgml

index 6c14da0cc76850f5cc167cc121b599ed8b11e7bc..e74b5be1effddc70a663320a3cf61a11d5fc401d 100644 (file)
@@ -3492,6 +3492,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
       <para>
        Boolean option to use binary transfer mode.  Binary mode is faster
        than the text mode but slightly less robust.
+       The default is <literal>off</literal>.
       </para>
      </listitem>
     </varlistentry>
@@ -3504,6 +3505,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
       <para>
        Boolean option to enable sending the messages that are written
        by <function>pg_logical_emit_message</function>.
+       The default is <literal>off</literal>.
       </para>
      </listitem>
     </varlistentry>
@@ -3533,6 +3535,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
       <para>
        Boolean option to enable two-phase transactions.   Minimum protocol
        version 3 is required to turn it on.
+       The default is <literal>off</literal>.
       </para>
      </listitem>
     </varlistentry>
@@ -3549,6 +3552,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
        to send the changes regardless of their origin.  This can be used
        to avoid loops (infinite replication of the same data) among
        replication nodes.
+       The default is <literal>any</literal>.
       </para>
      </listitem>
     </varlistentry>