RE: Make pgoutput documentation easier to find

From: "Hayato Kuroda (Fujitsu)" <kuroda(dot)hayato(at)fujitsu(dot)com>
To: 'Fujii Masao' <masao(dot)fujii(at)gmail(dot)com>
Cc: "pgsql-docs(at)lists(dot)postgresql(dot)org" <pgsql-docs(at)lists(dot)postgresql(dot)org>
Subject: RE: Make pgoutput documentation easier to find
Date: 2025-08-14 12:12:44
Message-ID: OSCPR01MB149665D6ED9B4C47323556453F535A@OSCPR01MB14966.jpnprd01.prod.outlook.com
Views: Whole Thread | Raw Message | Download mbox | Resend email
Thread:
Lists: pgsql-docs pgsql-hackers

Dear Fujii-san,

> 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.

Personally considered pgoutput is not the user-facing and extension developers
can dig by themselves, but this is not a huge complaint.
DBA may check their settings via pg_recvlogical, which is a use-case.

I did agree to add new chapter for plugin developers, but it could be done at
different thread.

Since pgoutput can only generate the binary output, it pg_logical_slot_get_changes()
cannot be used with this plugin. I felt this should be also documented.

Another point: test_decoding does not have descriptions for their options neither.
Should we also add as well?

Best regards,
Hayato Kuroda
FUJITSU LIMITED

In response to

Responses

Browse pgsql-docs by date

  From Date Subject
Next Message Álvaro Herrera 2025-08-14 12:24:45 Re: Broken NewbieDoc Docbook Guide link
Previous Message Chao Li 2025-08-14 04:04:40 Re: Make pgoutput documentation easier to find

Browse pgsql-hackers by date

  From Date Subject
Next Message Kirill Reshke 2025-08-14 12:20:07 Re: Add mode column to pg_stat_progress_vacuum
Previous Message Xuneng Zhou 2025-08-14 12:06:52 Re: memory leak in logical WAL sender with pgoutput's cachectx