Re: Documentation about PL transforms - Mailing list pgsql-hackers

From Chapman Flack
Subject Re: Documentation about PL transforms
Date
Msg-id 6215246A.1000309@anastigmatix.net
Whole thread Raw
In response to Re: Documentation about PL transforms  (Chapman Flack <chap@anastigmatix.net>)
Responses Re: Documentation about PL transforms  (chap@anastigmatix.net)
List pgsql-hackers
On 02/21/22 16:09, Chapman Flack wrote:
> On 02/07/22 15:14, Chapman Flack wrote:
>> I'll work on some doc patches.
> 
> It seems a bit of an impedance mismatch that there is a get_func_trftypes
> producing a C Oid[] (with its length returned separately), while
> get_transform_fromsql and get_transform_tosql both expect a List.
> ...
> Would it be reasonable to deprecate get_func_trftypes and instead
> provide a get_call_trftypes

It would have been painful to write documentation of get_func_trftypes
saying its result isn't what get_transform_{from.to}sql expect, so
patch 1 does add a get_call_trftypes that returns a List *.

Patch 2 then updates the docs as discussed in this thread. It turned out
plhandler.sgml was kind of a long monolith of text even before adding
transform information, so I broke it into sections first. This patch adds
the section markup without reindenting, so the changes aren't obscured.

The chapter had also fallen behind the introduction of procedures, so
I have changed many instances of 'function' to the umbrella term
'routine'.

Patch 3 simply reindents for the new section markup and rewraps.
Whitespace only.

Patch 4 updates src/test/modules/plsample to demonstrate handling of
transforms (and to add some more comments generally).

I'll add this to the CF.

Regards,
-Chap

Attachment

pgsql-hackers by date:

Previous
From: Nathan Bossart
Date:
Subject: Re: remove more archiving overhead
Next
From: Andres Freund
Date:
Subject: Re: bailing out in tap tests nearly always a bad idea