diff options
author | David Rowley <drowley@postgresql.org> | 2024-09-12 22:36:39 +1200 |
---|---|---|
committer | David Rowley <drowley@postgresql.org> | 2024-09-12 22:36:39 +1200 |
commit | 5bb9ba2739896d2977e7318658135ba7e356e169 (patch) | |
tree | 5d8e8bec9ef16b91ec26b399eee5581d2262f14c /doc/src | |
parent | fefa76f70fdc75c91f80bddce2df7a8825205962 (diff) | |
download | postgresql-5bb9ba2739896d2977e7318658135ba7e356e169.tar.gz postgresql-5bb9ba2739896d2977e7318658135ba7e356e169.zip |
Doc: alphabetize aggregate function table
A few recent JSON aggregates have been added without much consideration
to the existing order. Put these back in alphabetical order (with the
exception of the JSONB variant of each JSON aggregate).
Author: Wolfgang Walther <walther@technowledgy.de>
Reviewed-by: Marlene Reiterer <marlene.reiterer.03@gmail.com>
Discussion: https://postgr.es/m/6a7b910c-3feb-4006-b817-9b4759cb6bb6%40technowledgy.de
Backpatch-through: 16, where these aggregates were added
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/func.sgml | 96 |
1 files changed, 48 insertions, 48 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml index 1bde4091ca6..1370440fae2 100644 --- a/doc/src/sgml/func.sgml +++ b/doc/src/sgml/func.sgml @@ -21927,6 +21927,54 @@ SELECT NULLIF(value, '(none)') ... <row> <entry role="func_table_entry"><para role="func_signature"> + <indexterm> + <primary>json_agg_strict</primary> + </indexterm> + <function>json_agg_strict</function> ( <type>anyelement</type> ) + <returnvalue>json</returnvalue> + </para> + <para role="func_signature"> + <indexterm> + <primary>jsonb_agg_strict</primary> + </indexterm> + <function>jsonb_agg_strict</function> ( <type>anyelement</type> ) + <returnvalue>jsonb</returnvalue> + </para> + <para> + Collects all the input values, skipping nulls, into a JSON array. + Values are converted to JSON as per <function>to_json</function> + or <function>to_jsonb</function>. + </para></entry> + <entry>No</entry> + </row> + + <row> + <entry role="func_table_entry"><para role="func_signature"> + <indexterm><primary>json_arrayagg</primary></indexterm> + <function>json_arrayagg</function> ( + <optional> <replaceable>value_expression</replaceable> </optional> + <optional> <literal>ORDER BY</literal> <replaceable>sort_expression</replaceable> </optional> + <optional> { <literal>NULL</literal> | <literal>ABSENT</literal> } <literal>ON NULL</literal> </optional> + <optional> <literal>RETURNING</literal> <replaceable>data_type</replaceable> <optional> <literal>FORMAT JSON</literal> <optional> <literal>ENCODING UTF8</literal> </optional> </optional> </optional>) + </para> + <para> + Behaves in the same way as <function>json_array</function> + but as an aggregate function so it only takes one + <replaceable>value_expression</replaceable> parameter. + If <literal>ABSENT ON NULL</literal> is specified, any NULL + values are omitted. + If <literal>ORDER BY</literal> is specified, the elements will + appear in the array in that order rather than in the input order. + </para> + <para> + <literal>SELECT json_arrayagg(v) FROM (VALUES(2),(1)) t(v)</literal> + <returnvalue>[2, 1]</returnvalue> + </para></entry> + <entry>No</entry> + </row> + + <row> + <entry role="func_table_entry"><para role="func_signature"> <indexterm><primary>json_objectagg</primary></indexterm> <function>json_objectagg</function> ( <optional> { <replaceable>key_expression</replaceable> { <literal>VALUE</literal> | ':' } <replaceable>value_expression</replaceable> } </optional> @@ -22037,31 +22085,6 @@ SELECT NULLIF(value, '(none)') ... <row> <entry role="func_table_entry"><para role="func_signature"> - <indexterm><primary>json_arrayagg</primary></indexterm> - <function>json_arrayagg</function> ( - <optional> <replaceable>value_expression</replaceable> </optional> - <optional> <literal>ORDER BY</literal> <replaceable>sort_expression</replaceable> </optional> - <optional> { <literal>NULL</literal> | <literal>ABSENT</literal> } <literal>ON NULL</literal> </optional> - <optional> <literal>RETURNING</literal> <replaceable>data_type</replaceable> <optional> <literal>FORMAT JSON</literal> <optional> <literal>ENCODING UTF8</literal> </optional> </optional> </optional>) - </para> - <para> - Behaves in the same way as <function>json_array</function> - but as an aggregate function so it only takes one - <replaceable>value_expression</replaceable> parameter. - If <literal>ABSENT ON NULL</literal> is specified, any NULL - values are omitted. - If <literal>ORDER BY</literal> is specified, the elements will - appear in the array in that order rather than in the input order. - </para> - <para> - <literal>SELECT json_arrayagg(v) FROM (VALUES(2),(1)) t(v)</literal> - <returnvalue>[2, 1]</returnvalue> - </para></entry> - <entry>No</entry> - </row> - - <row> - <entry role="func_table_entry"><para role="func_signature"> <indexterm> <primary>json_object_agg_unique_strict</primary> </indexterm> @@ -22171,29 +22194,6 @@ SELECT NULLIF(value, '(none)') ... <row> <entry role="func_table_entry"><para role="func_signature"> <indexterm> - <primary>json_agg_strict</primary> - </indexterm> - <function>json_agg_strict</function> ( <type>anyelement</type> ) - <returnvalue>json</returnvalue> - </para> - <para role="func_signature"> - <indexterm> - <primary>jsonb_agg_strict</primary> - </indexterm> - <function>jsonb_agg_strict</function> ( <type>anyelement</type> ) - <returnvalue>jsonb</returnvalue> - </para> - <para> - Collects all the input values, skipping nulls, into a JSON array. - Values are converted to JSON as per <function>to_json</function> - or <function>to_jsonb</function>. - </para></entry> - <entry>No</entry> - </row> - - <row> - <entry role="func_table_entry"><para role="func_signature"> - <indexterm> <primary>string_agg</primary> </indexterm> <function>string_agg</function> ( <parameter>value</parameter> |