Re: Options OUTPUT_PLUGIN_* controlling format are confusing (Was: Misleading error message in logical decoding)

From: Michael Paquier <michael(dot)paquier(at)gmail(dot)com>
To: Andres Freund <andres(at)2ndquadrant(dot)com>
Cc: Robert Haas <robertmhaas(at)gmail(dot)com>, PostgreSQL mailing lists <pgsql-hackers(at)postgresql(dot)org>
Subject: Re: Options OUTPUT_PLUGIN_* controlling format are confusing (Was: Misleading error message in logical decoding)
Date: 2014-09-29 12:48:08
Message-ID: CAB7nPqSA0aPegJD0_5+1iwkZZk4+1d7nuWhPYwwwjVXAJUZg2w@mail.gmail.com
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-hackers

On Mon, Sep 29, 2014 at 7:50 PM, Andres Freund <andres(at)2ndquadrant(dot)com>
wrote:

> What about the attached patch then?
>

Thanks for this update. This looks good. Here are a couple of small
comments:
1) This sentence is correct English, but I don't recall seeing in the docs
such a formulation:
+ Can only be used on slots using a output plugin supporting textual
+ output.
I'd rather rewrite 'It can only be used' or 'this function can only be
used'. I imagine that you could add a reference to
logicaldecoding-output-mode as well.
2) s/a output/an output/g
3) The formulation here seems vague as a plugin that generates textual
output can call pg_logical_slot_peek_binary_changes as well:
- except that changes are returned as <type>bytea</type>.
+ except that changes are returned as <type>bytea</type> and that it
can
+ be used on slots using output plugins that only support binary
output.
4) What about reformulating the following:
+ so a <type>text</> can contain it. This is checked in assertion
enabled
+ builds.
"This is checked in builds with assertions enabled."
5) Better to add a newline between two portions sect2.
+ </sect2>
<sect2 id="logicaldecoding-output-plugin-callbacks">

Regards,
--
Michael

In response to

Responses

Browse pgsql-hackers by date

  From Date Subject
Next Message Michael Paquier 2014-09-29 12:51:12 Re: pg_receivexlog and replication slots
Previous Message Andres Freund 2014-09-29 12:42:01 Re: pg_receivexlog and replication slots