From: Peter Eisentraut <peter@eisentraut.org>
To: Fujii Masao <masao.fujii@gmail.com>
To: pgsql-docs@lists.postgresql.org
Subject: Re: Make pgoutput documentation easier to find
Date: Wed, 6 Aug 2025 13:36:21 +0200
Message-ID: <900b7421-1f32-47c7-9ad2-4144dfd7b679@eisentraut.org> (raw)
In-Reply-To: <CAHGQGwFJTbygdhhjR_iP4Oem=Lo1xsptWWOq825uoW+hG_Lfnw@mail.gmail.com>
References: <CAHGQGwFJTbygdhhjR_iP4Oem=Lo1xsptWWOq825uoW+hG_Lfnw@mail.gmail.com>
On 03.08.25 03:32, Fujii Masao wrote:
> The current documentation for pgoutput is buried in the logical streaming
> replication protocol section (in protocol.sgml), and there's no index entry
> for it. This makes it hard to discover and access, for example, when trying
> to look up the options it supports.
>
> I've often struggled to locate this information myself, so I'd like to
> propose moving the pgoutput documentation to the logical decoding section
> and adding an index entry. The attached patch does that. I think this change
> will make it much easier for users to find the relevant details.
This would move the documentation of pgoutput from "Internals" to
"Server Programming". So it's a question of whether this is something
we want to advertise that people can use directly. In the past,
pgoutput was an implementation detail of logical replication. But I
gather people are using it for other things now? Still not clear what
kind of guarantees we want to give about its interfaces, for example.
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-docs@postgresql.org
Cc: peter@eisentraut.org, masao.fujii@gmail.com, pgsql-docs@lists.postgresql.org
Subject: Re: Make pgoutput documentation easier to find
In-Reply-To: <900b7421-1f32-47c7-9ad2-4144dfd7b679@eisentraut.org>
* 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