pgsql: Doc: improve documentation for jsonpath behavior.

From: Tom Lane <tgl(at)sss(dot)pgh(dot)pa(dot)us>
To: pgsql-committers(at)lists(dot)postgresql(dot)org
Subject: pgsql: Doc: improve documentation for jsonpath behavior.
Date: 2024-01-25 16:32:32
Message-ID: E1rT2eW-0033xb-V9@gemulon.postgresql.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-committers

Doc: improve documentation for jsonpath behavior.

Clarify the behavior of jsonpath operators and functions by
describing their two different modes of operation explicitly.
In addition to the SQL-spec behavior, where a path returns
a list of matching items, we have a "predicate check" form
that always returns a single boolean result. That was mentioned
in only one place, but it seems better to annotate each operator
and function as to which form(s) it takes. Also improve the
examples by converting them into actual executable SQL with
results, and do a bunch of incidental wordsmithing.

David Wheeler, reviewed by Erik Wienhold, Jian He, and myself

Discussion: https://postgr.es/m/7262A188-59CA-4A8A-AAD7-83D4FF0B9758@justatheory.com

Branch
------
master

Details
-------
https://git.postgresql.org/pg/commitdiff/7014c9a4bba2d1b67d60687afb5b2091c1d07f73

Modified Files
--------------
doc/src/sgml/func.sgml | 389 ++++++++++++++++++++++++++++++++++---------------
doc/src/sgml/json.sgml | 2 +-
2 files changed, 271 insertions(+), 120 deletions(-)

Browse pgsql-committers by date

  From Date Subject
Next Message Andrew Dunstan 2024-01-25 21:25:59 pgsql: Clean up a bug in sql/json items commit 66ea94e8e6
Previous Message Andrew Dunstan 2024-01-25 15:24:28 pgsql: Implement various jsonpath methods