On 20/09/22 03:33, Michael Paquier wrote:
> On Mon, Sep 19, 2022 at 07:02:16PM +0200, Florin Irion wrote:
>> This was introduced in commit 19890a06.
>>
>> IMHO we should use the documented argument name `two_phase` and change the
>> function to accept it.
>>
>> What do you think?
>
> 19890a0 is included in REL_14_STABLE, and changing an argument name is
> not acceptable in a stable branch as it would imply a catversion
> bump. Let's change the docs so as we document the parameter as
> "twophase", instead.
> --
> Michael
I understand.
OK, patch only for the docs attached.
Cheers,
Florin
www.enterprisedb.com
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index f63a04c667..f1a8a9a0ba 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -25891,7 +25891,7 @@ postgres=# SELECT * FROM
pg_walfile_name_offset(pg_stop_backup());
<indexterm>
<primary>pg_create_logical_replication_slot</primary>
</indexterm>
- <function>pg_create_logical_replication_slot</function> (
<parameter>slot_name</parameter> <type>name</type>,
<parameter>plugin</parameter> <type>name</type> <optional>,
<parameter>temporary</parameter> <type>boolean</type>,
<parameter>two_phase</parameter> <type>boolean</type> </optional> )
+ <function>pg_create_logical_replication_slot</function> (
<parameter>slot_name</parameter> <type>name</type>,
<parameter>plugin</parameter> <type>name</type> <optional>,
<parameter>temporary</parameter> <type>boolean</type>,
<parameter>twophase</parameter> <type>boolean</type> </optional> )
<returnvalue>record</returnvalue>
( <parameter>slot_name</parameter> <type>name</type>,
<parameter>lsn</parameter> <type>pg_lsn</type> )
@@ -25904,7 +25904,7 @@ postgres=# SELECT * FROM
pg_walfile_name_offset(pg_stop_backup());
the slot should not be permanently stored to disk and is only meant
for use by the current session. Temporary slots are also
released upon any error. The optional fourth parameter,
- <parameter>two_phase</parameter>, when set to true, specifies
+ <parameter>twophase</parameter>, when set to true, specifies
that the decoding of prepared transactions is enabled for this
slot. A call to this function has the same effect as the replication
protocol command <literal>CREATE_REPLICATION_SLOT ...
LOGICAL</literal>.
