pgsql: Doc: clarify behavior of row-limit arguments in the PLs' SPI wra

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: clarify behavior of row-limit arguments in the PLs' SPI wra
Date: 2023-05-02 21:55:15
Message-ID: E1ptxxq-000Aiy-Is@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

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

Branch
------
REL_14_STABLE

Details
-------
https://git.postgresql.org/pg/commitdiff/66ab2660e0783fd4f6be5936e17a2c8e12335d0d

Modified Files
--------------
doc/src/sgml/plperl.sgml | 21 ++++++++++++++++-----
doc/src/sgml/plpython.sgml | 13 +++++++++++--
doc/src/sgml/pltcl.sgml | 8 +++++---
3 files changed, 32 insertions(+), 10 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Amit Kapila 2023-05-03 05:09:39 pgsql: Fix assertion failure in apply worker.
Previous Message Daniel Gustafsson 2023-05-02 11:23:53 pgsql: Fix overridden callbacks in pg_rewind.