Re: doc examples for pghandler

On Fri, Jun 12, 2020 at 03:10:20PM -0400, Tom Lane wrote:
> Mark Wong <mark(at)2ndquadrant(dot)com> writes:
> > Would some additional procedure language handler code examples in the
> > documentation be good to add? I've put some together in the attached
> > patch, and can log it to a future commitfest if people think it would
> > be a good addition.
>
> Hmm. The existing doc examples are really pretty laughable, because
> there's such a large gap between the offered skeleton and a workable
> handler. So I agree it'd be nice to do better, but I'm suspicious of
> having large chunks of sample code in the docs --- that's a maintenance
> problem, if only because we likely won't notice when we break it.
> Also, if somebody is hoping to copy-and-paste such code, it isn't
> that nice to work from if it's embedded in SGML.
>
> I wonder if it'd be possible to adapt what you have here into some
> tiny contrib module that doesn't do very much useful, but can at
> least be tested to see that it compiles; moreover it could be
> copied verbatim to serve as a starting point for a new PL.

I do have the code examples in a repo. [1] The 0.4 directory consists
of everything the examples show.

It would be easy enough to adapt that for contrib, and move some of the
content from the doc patch into that. Then touch up the handler chapter
to reference the contrib module.

Does that sound more useful?

[1] https://gitlab.com/markwkm/yappl

--
Mark Wong
2ndQuadrant - PostgreSQL Solutions for the Enterprise
https://www.2ndQuadrant.com/