summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2019-08-27 16:37:22 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2019-08-27 16:37:22 -0400
commit5efa4a3e7008638732d14ffd7613f53823a75367 (patch)
treed6181fc81ac2bddc482b7ac87e005d28a19550bf
parent465f4dddae6bfe882f95e9e04633c7c496826ac2 (diff)
Doc: clarify behavior of standard aggregates for null inputs.
Section 4.2.7 says that unless otherwise specified, built-in aggregates ignore rows in which any input is null. This is not true of the JSON aggregates, but it wasn't documented. Fix that. Of the other entries in table 9.55, some were explicit about ignoring nulls, and some weren't; for consistency and self-contained-ness, make them all say it explicitly. Per bug #15884 from Tim Möhlmann. Back-patch to all supported branches. Discussion: https://postgr.es/m/15884-c32d848f787fcae3@postgresql.org
-rw-r--r--doc/src/sgml/func.sgml26
1 files changed, 15 insertions, 11 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index b5a6cd5a36b..0a38693b733 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -12910,7 +12910,7 @@ NULL baz</literallayout>(3 rows)</entry>
<entry>No</entry>
<entry>input arrays concatenated into array of one higher dimension
(inputs must all have same dimensionality,
- and cannot be empty or NULL)</entry>
+ and cannot be empty or null)</entry>
</row>
<row>
@@ -12934,7 +12934,7 @@ NULL baz</literallayout>(3 rows)</entry>
otherwise the same as the argument data type
</entry>
<entry>Yes</entry>
- <entry>the average (arithmetic mean) of all input values</entry>
+ <entry>the average (arithmetic mean) of all non-null input values</entry>
</row>
<row>
@@ -13062,7 +13062,7 @@ NULL baz</literallayout>(3 rows)</entry>
<type>json</type>
</entry>
<entry>No</entry>
- <entry>aggregates values as a JSON array</entry>
+ <entry>aggregates values, including nulls, as a JSON array</entry>
</row>
<row>
@@ -13079,7 +13079,7 @@ NULL baz</literallayout>(3 rows)</entry>
<type>jsonb</type>
</entry>
<entry>No</entry>
- <entry>aggregates values as a JSON array</entry>
+ <entry>aggregates values, including nulls, as a JSON array</entry>
</row>
<row>
@@ -13096,7 +13096,8 @@ NULL baz</literallayout>(3 rows)</entry>
<type>json</type>
</entry>
<entry>No</entry>
- <entry>aggregates name/value pairs as a JSON object</entry>
+ <entry>aggregates name/value pairs as a JSON object; values can be
+ null, but not names</entry>
</row>
<row>
@@ -13113,7 +13114,8 @@ NULL baz</literallayout>(3 rows)</entry>
<type>jsonb</type>
</entry>
<entry>No</entry>
- <entry>aggregates name/value pairs as a JSON object</entry>
+ <entry>aggregates name/value pairs as a JSON object; values can be
+ null, but not names</entry>
</row>
<row>
@@ -13129,7 +13131,7 @@ NULL baz</literallayout>(3 rows)</entry>
<entry>Yes</entry>
<entry>
maximum value of <replaceable
- class="parameter">expression</replaceable> across all input
+ class="parameter">expression</replaceable> across all non-null input
values
</entry>
</row>
@@ -13147,7 +13149,7 @@ NULL baz</literallayout>(3 rows)</entry>
<entry>Yes</entry>
<entry>
minimum value of <replaceable
- class="parameter">expression</replaceable> across all input
+ class="parameter">expression</replaceable> across all non-null input
values
</entry>
</row>
@@ -13169,7 +13171,7 @@ NULL baz</literallayout>(3 rows)</entry>
same as argument types
</entry>
<entry>No</entry>
- <entry>input values concatenated into a string, separated by delimiter</entry>
+ <entry>non-null input values concatenated into a string, separated by delimiter</entry>
</row>
<row>
@@ -13192,7 +13194,8 @@ NULL baz</literallayout>(3 rows)</entry>
argument data type
</entry>
<entry>Yes</entry>
- <entry>sum of <replaceable class="parameter">expression</replaceable> across all input values</entry>
+ <entry>sum of <replaceable class="parameter">expression</replaceable>
+ across all non-null input values</entry>
</row>
<row>
@@ -13209,7 +13212,8 @@ NULL baz</literallayout>(3 rows)</entry>
<type>xml</type>
</entry>
<entry>No</entry>
- <entry>concatenation of XML values (see also <xref linkend="functions-xml-xmlagg">)</entry>
+ <entry>concatenation of non-null XML values
+ (see also <xref linkend="functions-xml-xmlagg">)</entry>
</row>
</tbody>
</tgroup>