From: Florin Irion <irionr@gmail.com>
To: Michael Paquier <michael@paquier.xyz>
Cc: pgsql-hackers@postgresql.org
Subject: Re: pg_create_logical_replication_slot argument incongruency
Date: Tue, 20 Sep 2022 08:41:56 +0200
Message-ID: <5eeabd10-1aff-ea61-f92d-9fa0d9a7e207@gmail.com> (raw)
In-Reply-To: <YykYZI8RChKycDe9@paquier.xyz>
References: <CA+HEvJDmFSKmqaXYuPNjkGpTboE35s_PifOg2AqwVJBn5rWGzw@mail.gmail.com>
<YykYZI8RChKycDe9@paquier.xyz>
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
Attachments:two_phase_slot_v2.patch (text/plain, 1.8K) downloaddiff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgmlindex 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>.
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Reply to all the recipients using the --to and --cc options:
reply via email
To: pgsql-hackers@postgresql.org
Cc: irionr@gmail.com, michael@paquier.xyz
Subject: Re: pg_create_logical_replication_slot argument incongruency
In-Reply-To: <5eeabd10-1aff-ea61-f92d-9fa0d9a7e207@gmail.com>
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
This inbox is served by DDX for PostgreSQL; see mirroring instructions
for how to clone and mirror all data and code used for this inbox