Re: Make pgoutput documentation easier to find

On Wed, Aug 6, 2025 at 8:36 PM Peter Eisentraut <peter@eisentraut.org> wrote:
>
> 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?

I've heard that Debezium users, a tool for change data capture, can use
pgoutput as the logical decoding plugin. I also know users, including
some of my colleagues, who use pgoutput with pg_recvlogical to capture
messages inserted via pg_logical_emit_message().

So I think making the pgoutput documentation easier to find would be
helpful for those users.

Regards,

--
Fujii Masao