Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 2aece25

Browse files
author
Nikita Glukhov
committed
Fix docs for SQL/JSON constructors: replaceable => parameter
1 parent c010a78 commit 2aece25

File tree

1 file changed

+33
-27
lines changed

1 file changed

+33
-27
lines changed

doc/src/sgml/func.sgml

Lines changed: 33 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -16928,8 +16928,8 @@ $ ? (@ like_regex "^\\d+$")
1692816928
<refsynopsisdiv>
1692916929
<synopsis>
1693016930
JSON_OBJECT (
16931-
[ { <replaceable class="parameter">key_expression</replaceable> { VALUE | ':' }
16932-
<replaceable class="parameter">value_expression</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ] }[, ...] ]
16931+
[ { <parameter>key_expression</parameter> { VALUE | ':' }
16932+
<parameter>value_expression</parameter> [ FORMAT JSON [ ENCODING UTF8 ] ] }[, ...] ]
1693316933
[ { NULL | ABSENT } ON NULL ]
1693416934
[ { WITH | WITHOUT } UNIQUE [ KEYS ] ]
1693516935
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
@@ -16953,8 +16953,8 @@ JSON_OBJECT (
1695316953

1695416954
<varlistentry>
1695516955
<term>
16956-
<literal><replaceable class="parameter">key_expression</replaceable> { VALUE | ':' }
16957-
<replaceable class="parameter">value_expression</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
16956+
<literal><parameter>key_expression</parameter> { VALUE | ':' }
16957+
<parameter>value_expression</parameter> [ FORMAT JSON [ ENCODING UTF8 ] ]</literal>
1695816958
</term>
1695916959
<listitem>
1696016960
<para>
@@ -16963,27 +16963,30 @@ JSON_OBJECT (
1696316963
<itemizedlist>
1696416964
<listitem>
1696516965
<para>
16966-
<replaceable class="parameter">key_expression</replaceable> is a scalar expression defining the
16967-
<acronym>JSON</acronym> key, which is implicitly converted
16968-
to the <type>text</type> type.
16969-
The provided expression cannot be <literal>NULL</literal> or belong to a type that has a cast to <type>json</type>.
16966+
<parameter>key_expression</parameter> is a scalar expression
16967+
defining the <acronym>JSON</acronym> key, which is implicitly
16968+
converted to the <type>text</type> type.
16969+
The provided expression cannot be <literal>NULL</literal> or
16970+
belong to a type that has a cast to <type>json</type>.
1697016971
</para>
1697116972
</listitem>
1697216973
<listitem>
1697316974
<para>
16974-
<replaceable class="parameter">value_expression</replaceable> is an expression
16975+
<parameter>value_expression</parameter> is an expression
1697516976
that provides the input for the <acronym>JSON</acronym> value.
1697616977
</para>
1697716978
</listitem>
1697816979
<listitem>
1697916980
<para>
16980-
The optional <literal>FORMAT</literal> clause is provided to conform to the SQL/JSON standard.
16981+
The optional <literal>FORMAT</literal> clause is provided to
16982+
conform to the SQL/JSON standard.
1698116983
</para>
1698216984
</listitem>
1698316985
</itemizedlist>
1698416986
<para>
16985-
You must use a colon or the <literal>VALUE</literal> keyword as a delimiter between
16986-
the key and the value. Multiple key/value pairs are separated by commas.
16987+
You must use a colon or the <literal>VALUE</literal> keyword as a
16988+
delimiter between the key and the value. Multiple key/value pairs are
16989+
separated by commas.
1698716990
</para>
1698816991
</listitem>
1698916992
</varlistentry>
@@ -17140,7 +17143,7 @@ WHERE f.did = 103;
1714017143

1714117144
<refsynopsisdiv>
1714217145
<synopsis>JSON_OBJECTAGG (
17143-
[ { <replaceable class="parameter">key_expression</replaceable> { VALUE | ':' } <replaceable class="parameter">value_expression</replaceable> } ]
17146+
[ { <parameter>key_expression</parameter> { VALUE | ':' } <parameter>value_expression</parameter> } ]
1714417147
[ { NULL | ABSENT } ON NULL ]
1714517148
[ { WITH | WITHOUT } UNIQUE [ KEYS ] ]
1714617149
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
@@ -17167,7 +17170,7 @@ WHERE f.did = 103;
1716717170
<variablelist>
1716817171
<varlistentry>
1716917172
<term>
17170-
<literal><replaceable class="parameter">key_expression</replaceable> { VALUE | ':' } <replaceable class="parameter">value_expression</replaceable></literal>
17173+
<literal><parameter>key_expression</parameter> { VALUE | ':' } <parameter>value_expression</parameter></literal>
1717117174
</term>
1717217175
<listitem>
1717317176

@@ -17177,16 +17180,18 @@ WHERE f.did = 103;
1717717180
<itemizedlist>
1717817181
<listitem>
1717917182
<para>
17180-
<replaceable class="parameter">key_expression</replaceable> is a scalar expression defining the
17181-
<acronym>JSON</acronym> key, which is implicitly converted
17182-
to the <type>text</type> type.
17183-
The provided expression cannot be <literal>NULL</literal> or belong to a type that has a cast to <type>json</type>.
17183+
<parameter>key_expression</parameter> is a scalar expression
17184+
defining the <acronym>JSON</acronym> key, which is implicitly
17185+
converted to the <type>text</type> type.
17186+
The provided expression cannot be <literal>NULL</literal> or
17187+
belong to a type that has a cast to <type>json</type>.
1718417188
</para>
1718517189
</listitem>
1718617190
<listitem>
1718717191
<para>
17188-
<replaceable class="parameter">value_expression</replaceable> is an expression
17189-
that provides the input for the <acronym>JSON</acronym> value preceded by its type.
17192+
<parameter>value_expression</parameter> is an expression that
17193+
provides the input for the <acronym>JSON</acronym> value preceded
17194+
by its type.
1719017195
For <acronym>JSON</acronym> scalar types, you can omit the type.
1719117196
</para>
1719217197
<note>
@@ -17364,7 +17369,7 @@ Action | { "Vertigo" : "02:08:00", "48 Hrs" : "01:37:00", "Taxi Driver" :
1736417369

1736517370
<refsynopsisdiv>
1736617371
<synopsis>JSON_ARRAY (
17367-
[ { <replaceable class="parameter">value_expression</replaceable> [ FORMAT JSON ] } [, ...] ]
17372+
[ { <parameter>value_expression</parameter> [ FORMAT JSON ] } [, ...] ]
1736817373
[ { NULL | ABSENT } ON NULL ]
1736917374
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
1737017375
)
@@ -17391,7 +17396,7 @@ Action | { "Vertigo" : "02:08:00", "48 Hrs" : "01:37:00", "Taxi Driver" :
1739117396
<variablelist>
1739217397
<varlistentry>
1739317398
<term>
17394-
<literal><replaceable class="parameter">value_expression</replaceable></literal>
17399+
<literal><parameter>value_expression</parameter></literal>
1739517400
</term>
1739617401
<listitem>
1739717402

@@ -17536,7 +17541,7 @@ AS film_titles;
1753617541

1753717542
<refsynopsisdiv>
1753817543
<synopsis>JSON_ARRAYAGG (
17539-
[ <replaceable class="parameter">value_expression</replaceable> ]
17544+
[ <parameter>value_expression</parameter> ]
1754017545
[ ORDER BY <replaceable class="parameter">sort_expression</replaceable> ]
1754117546
[ { NULL | ABSENT } ON NULL ]
1754217547
[ RETURNING <replaceable class="parameter">data_type</replaceable> [ FORMAT JSON [ ENCODING UTF8 ] ]
@@ -17560,14 +17565,15 @@ AS film_titles;
1756017565
<variablelist>
1756117566
<varlistentry>
1756217567
<term>
17563-
<literal><replaceable class="parameter">value_expression</replaceable></literal>
17568+
<literal><parameter>value_expression</parameter></literal>
1756417569
</term>
1756517570
<listitem>
1756617571

1756717572
<para>
17568-
The input clause that provides the input data to be aggregated as a <acronym>JSON</acronym> array.
17569-
The <replaceable class="parameter">value_expression</replaceable>
17570-
can be a value or a query returning the values to be used as input in array construction.
17573+
The input clause that provides the input data to be aggregated as
17574+
a <acronym>JSON</acronym> array.
17575+
The <parameter>value_expression</parameter> can be a value or a query
17576+
returning the values to be used as input in array construction.
1757117577
You can provide multiple input values separated by commas.
1757217578
</para>
1757317579
</listitem>

0 commit comments

Comments
 (0)