diff options
| author | Bruce Momjian <bruce@momjian.us> | 2024-11-20 17:03:45 -0500 |
|---|---|---|
| committer | Bruce Momjian <bruce@momjian.us> | 2024-11-20 17:03:45 -0500 |
| commit | 70236cf22f4c42338d25c07f7fd00bd5c5830eb5 (patch) | |
| tree | 20fead7f4227e29bde7d2bd0fdaffc6f661fbf90 /doc/src | |
| parent | f722dd32de49af883b7b58d0ca028835972b7095 (diff) | |
| download | postgresql-70236cf22f4c42338d25c07f7fd00bd5c5830eb5.tar.gz postgresql-70236cf22f4c42338d25c07f7fd00bd5c5830eb5.zip | |
doc: clarify that jsonb_path_match() returns an SQL boolean
Not a JSON boolean. Also clarify that other predicate check expressions
functions return a JSON boolean, not an SQL boolean.
Reported-by: jian he
Discussion: https://postgr.es/m/CACJufxH7tP1NXCHN1bUBXcEB=dv7-qE+ZjB3UxwK6Em+9Qzb9Q@mail.gmail.com
Backpatch-through: 17
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/func.sgml | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 72f223a0414..13ccbe7d78c 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -17178,8 +17178,8 @@ ERROR: value too long for type character(2) <returnvalue>boolean</returnvalue> </para> <para> - Returns the result of a JSON path predicate check for the specified - JSON value. + Returns the SQL boolean result of a JSON path predicate check + for the specified JSON value. (This is useful only with <link linkend="functions-sqljson-check-expressions">predicate check expressions</link>, not SQL-standard JSON path expressions, @@ -17646,9 +17646,9 @@ SELECT '{ Boolean predicate, whereas the SQL standard allows predicates only within filters. While SQL-standard path expressions return the relevant element(s) of the queried JSON value, predicate check expressions - return the single three-valued result of the + return the single three-valued <type>jsonb</type> result of the predicate: <literal>true</literal>, - <literal>false</literal>, or <literal>unknown</literal>. + <literal>false</literal>, or <literal>null</literal>. For example, we could write this SQL-standard filter expression: <screen> <prompt>=></prompt> <userinput>select jsonb_path_query(:'json', '$.track.segments ?(@[*].HR > 130)');</userinput> |