Doc: clarify behavior of row-limit arguments in the PLs' SPI wrappers.
authorTom Lane <tgl@sss.pgh.pa.us>
Tue, 2 May 2023 21:55:01 +0000 (17:55 -0400)
committerTom Lane <tgl@sss.pgh.pa.us>
Tue, 2 May 2023 21:55:01 +0000 (17:55 -0400)
commit6489875ce6b16662142bc70e003437b9753c199f
tree178cbd305a92055daac09148272a9e562677f2bb
parent08237056f84e3a9ed75e8a698428c669f4d35db4
Doc: clarify behavior of row-limit arguments in the PLs' SPI wrappers.

plperl, plpython, and pltcl all provide query-execution functions
that are thin wrappers around SPI_execute() or its variants.
The SPI functions document their row-count limit arguments clearly,
as "maximum number of rows to return, or 0 for no limit".  However
the PLs' documentation failed to explain this special behavior of
zero, so that a reader might well assume it means "fetch zero
rows".  Improve that.

Daniel Gustafsson and Tom Lane, per report from Kieran McCusker

Discussion: https://postgr.es/m/CAGgUQ6H6qYScctOhktQ9HLFDDoafBKHyUgJbZ6q_dOApnzNTXg@mail.gmail.com
doc/src/sgml/plperl.sgml
doc/src/sgml/plpython.sgml
doc/src/sgml/pltcl.sgml