Skip to content

Commit 903feea

Browse files
author
Nikita Glukhov
committed
Fix docs for SQL/JSON constructors: [] => optional
1 parent 2aece25 commit 903feea

File tree

1 file changed

+35
-30
lines changed

1 file changed

+35
-30
lines changed

‎doc/src/sgml/func.sgml

Lines changed: 35 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16927,12 +16927,12 @@ $ ? (@ like_regex "^\\d+$")
1692716927

1692816928
<refsynopsisdiv>
1692916929
<synopsis>
16930-
JSON_OBJECT (
16931-
[ { <parameter>key_expression</parameter> { VALUE | ':' }
16932-
<parameter>value_expression</parameter> [ FORMAT JSON [ ENCODING UTF8 ] ] }[, ...] ]
16933-
[ { NULL | ABSENT } ON NULL ]
16934-
[ { WITH | WITHOUT } UNIQUE [ KEYS ] ]
16935-
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
16930+
<function>JSON_OBJECT</function> (
16931+
<optional> { <parameter>key_expression</parameter> { VALUE | ':' }
16932+
<parameter>value_expression</parameter> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> }<optional>, ...</optional> </optional>
16933+
<optional> { NULL | ABSENT } ON NULL </optional>
16934+
<optional> { WITH | WITHOUT } UNIQUE <optional> KEYS </optional> </optional>
16935+
<optional> RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> </optional>
1693616936
)
1693716937

1693816938
</synopsis>
@@ -16953,8 +16953,10 @@ JSON_OBJECT (
1695316953

1695416954
<varlistentry>
1695516955
<term>
16956-
<literal><parameter>key_expression</parameter> { VALUE | ':' }
16957-
<parameter>value_expression</parameter> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
16956+
<literal>
16957+
<parameter>key_expression</parameter> { VALUE | ':' }
16958+
<parameter>value_expression</parameter> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional>
16959+
</literal>
1695816960
</term>
1695916961
<listitem>
1696016962
<para>
@@ -17025,7 +17027,7 @@ JSON_OBJECT (
1702517027

1702617028
<varlistentry>
1702717029
<term>
17028-
<literal>{ WITH | WITHOUT } UNIQUE [ KEYS ]</literal>
17030+
<literal>{ WITH | WITHOUT } UNIQUE <optional> KEYS </optional></literal>
1702917031
</term>
1703017032
<listitem>
1703117033
<para>Defines whether duplicate keys are allowed:
@@ -17059,7 +17061,7 @@ JSON_OBJECT (
1705917061

1706017062
<varlistentry>
1706117063
<term>
17062-
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
17064+
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional></literal>
1706317065
</term>
1706417066
<listitem>
1706517067
<para>
@@ -17142,11 +17144,12 @@ WHERE f.did = 103;
1714217144
</refnamediv>
1714317145

1714417146
<refsynopsisdiv>
17145-
<synopsis>JSON_OBJECTAGG (
17146-
[ { <parameter>key_expression</parameter> { VALUE | ':' } <parameter>value_expression</parameter> } ]
17147-
[ { NULL | ABSENT } ON NULL ]
17148-
[ { WITH | WITHOUT } UNIQUE [ KEYS ] ]
17149-
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
17147+
<synopsis>
17148+
<function>JSON_OBJECTAGG</function> (
17149+
<optional> { <parameter>key_expression</parameter> { VALUE | ':' } <parameter>value_expression</parameter> } </optional>
17150+
<optional> { NULL | ABSENT } ON NULL </optional>
17151+
<optional> { WITH | WITHOUT } UNIQUE <optional> KEYS </optional> </optional>
17152+
<optional> RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> </optional>
1715017153
)
1715117154

1715217155
</synopsis>
@@ -17244,7 +17247,7 @@ WHERE f.did = 103;
1724417247

1724517248
<varlistentry>
1724617249
<term>
17247-
<literal>{ WITH | WITHOUT } UNIQUE [ KEYS ]</literal>
17250+
<literal>{ WITH | WITHOUT } UNIQUE <optional> KEYS </optional></literal>
1724817251
</term>
1724917252
<listitem>
1725017253
<para>Defines whether duplicate keys are allowed:
@@ -17278,7 +17281,7 @@ WHERE f.did = 103;
1727817281

1727917282
<varlistentry>
1728017283
<term>
17281-
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
17284+
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional></literal>
1728217285
</term>
1728317286
<listitem>
1728417287
<para>
@@ -17368,15 +17371,16 @@ Action | { "Vertigo" : "02:08:00", "48 Hrs" : "01:37:00", "Taxi Driver" :
1736817371
</refnamediv>
1736917372

1737017373
<refsynopsisdiv>
17371-
<synopsis>JSON_ARRAY (
17372-
[ { <parameter>value_expression</parameter> [ FORMAT JSON ] } [, ...] ]
17373-
[ { NULL | ABSENT } ON NULL ]
17374-
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
17374+
<synopsis>
17375+
<function>JSON_ARRAY</function> (
17376+
<optional> { <parameter>value_expression</parameter> <optional> FORMAT JSON </optional> } <optional>, ...</optional> </optional>
17377+
<optional> { NULL | ABSENT } ON NULL </optional>
17378+
<optional> RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> </optional>
1737517379
)
1737617380
</synopsis>
1737717381
<synopsis>JSON_ARRAY (
17378-
[ <replaceable class="parameter">query_expression</replaceable> ]
17379-
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
17382+
<optional> <replaceable class="parameter">query_expression</replaceable> </optional>
17383+
<optional> RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> </optional>
1738017384
)
1738117385
</synopsis>
1738217386
</refsynopsisdiv>
@@ -17468,7 +17472,7 @@ Action | { "Vertigo" : "02:08:00", "48 Hrs" : "01:37:00", "Taxi Driver" :
1746817472

1746917473
<varlistentry>
1747017474
<term>
17471-
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
17475+
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional></literal>
1747217476
</term>
1747317477
<listitem>
1747417478
<para>
@@ -17540,11 +17544,12 @@ AS film_titles;
1754017544
</refnamediv>
1754117545

1754217546
<refsynopsisdiv>
17543-
<synopsis>JSON_ARRAYAGG (
17544-
[ <parameter>value_expression</parameter> ]
17545-
[ ORDER BY <replaceable class="parameter">sort_expression</replaceable> ]
17546-
[ { NULL | ABSENT } ON NULL ]
17547-
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
17547+
<synopsis>
17548+
<function>JSON_ARRAYAGG</function> (
17549+
<optional> <parameter>value_expression</parameter> </optional>
17550+
<optional> ORDER BY <replaceable class="parameter">sort_expression</replaceable> </optional>
17551+
<optional> { NULL | ABSENT } ON NULL </optional>
17552+
<optional> RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional> </optional>
1754817553
)
1754917554

1755017555
</synopsis>
@@ -17617,7 +17622,7 @@ AS film_titles;
1761717622

1761817623
<varlistentry>
1761917624
<term>
17620-
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
17625+
<literal>RETURNING <replaceable class="parameter">data_type</replaceable> <optional> FORMAT JSON <optional> ENCODING UTF8 </optional> </optional></literal>
1762117626
</term>
1762217627
<listitem>
1762317628
<para>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy