Re: Document default values for pgoutput options + fix missing initialization for "origin"
Amit Kapila <amit.kapila16@gmail.com>
From: Amit Kapila <amit.kapila16@gmail.com>
To: Euler Taveira <euler@eulerto.com>
Cc: pgsql-hackers@lists.postgresql.org, masao.fujii@oss.nttdata.com
Date: 2025-05-20T04:09:44Z
Lists: pgsql-hackers
On Tue, May 20, 2025 at 8:11 AM Euler Taveira <euler@eulerto.com> wrote: > > On Fri, May 16, 2025, at 12:06 PM, Fujii Masao wrote: > > The pgoutput plugin options are documented in the logical streaming > replication protocol, but their default values are not mentioned. > This can be inconvenient for users - for example, when using pg_recvlogical > with pgoutput plugin and needing to know the default behavior of each option. > https://www.postgresql.org/docs/devel/protocol-logical-replication.html > > I'd like to propose adding the default values to the documentation to > improve clarity and usability. Patch attached (0001 patch). > > > Good catch. > > Should we use "on" and "off" as other enum GUCs (wal_compression, > recovery_prefetch, compute_query_id)? The current convention is to support > other ways (true / false / 1 / 0) to write boolean but only document one way > (on / off). > > Since you are changing this page, I would like to suggest removing "Boolean" > from streaming option. It is not a boolean anymore since protocol version 4. > The suggested description is: > > + Option to enable streaming of in-progress transactions. Valid values are > + <literal>off</literal> (the default), <literal>on</literal> and > + <literal>parallel</literal>. The setting <literal>parallel</literal> > + enables sending extra information with some messages to be used for > + 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. > One point to note about this is that we change the default value for the streaming option to parallel for a subscription in the commit 1bf1140be8. But pgoutput still considers the default value to be off. I thought about this, but not sure if there is any clear value in changing the default of pgoutput. Would you have any thoughts on the same? -- With Regards, Amit Kapila.
Commits
Same data as JSON:
GET /api/v1/messages/:b64id/commits
the thread's linked commits as JSON, with link sources.
API reference →
-
pgoutput: Initialize missing default for "origin" parameter.
- b8341ae856f2 19 (unreleased) landed
-
doc: Document default values for pgoutput options in protocol.sgml.
- d8425811b681 19 (unreleased) landed
-
doc: Fix confusing description of streaming option in START_REPLICATION.
- e92573917a49 16.10 landed
- 488c35f958e7 17.6 landed
- ac7c04483106 18.0 landed
- 09fcc652fefd 19 (unreleased) landed
-
Change the default value of the streaming option to 'parallel'.
- 1bf1140be872 18.0 cited
-
Allow users to skip logical replication of data having origin.
- 366283961ac0 16.0 cited