summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Lane <tgl@sss.pgh.pa.us>2019-09-23 12:37:04 -0400
committerTom Lane <tgl@sss.pgh.pa.us>2019-09-23 12:37:04 -0400
commit65cddf70aafcac0945947a6966cb316a8dcb91c3 (patch)
tree874a8e137fb7c0bdd67502f7de75250e23ed2a87
parent35eb132700ba9aaab60536ee839e5101454dcde3 (diff)
Doc: clarify handling of duplicate elements in array containment tests.
The array <@ and @> operators do not worry about duplicates: if every member of array X matches some element of array Y, then X is contained in Y, even if several members of X get matched to the same Y member. This was not explicitly stated in the docs though, so improve matters. Discussion: https://postgr.es/m/156614120484.1310.310161642239149585@wrigleys.postgresql.org
-rw-r--r--doc/src/sgml/func.sgml19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/src/sgml/func.sgml b/doc/src/sgml/func.sgml
index 6d7c2afe8fc..90791dfa2f1 100644
--- a/doc/src/sgml/func.sgml
+++ b/doc/src/sgml/func.sgml
@@ -11671,14 +11671,14 @@ SELECT NULLIF(value, '(none)') ...
<row>
<entry> <literal>@&gt;</literal> </entry>
<entry>contains</entry>
- <entry><literal>ARRAY[1,4,3] @&gt; ARRAY[3,1]</literal></entry>
+ <entry><literal>ARRAY[1,4,3] @&gt; ARRAY[3,1,3]</literal></entry>
<entry><literal>t</literal></entry>
</row>
<row>
<entry> <literal>&lt;@</literal> </entry>
<entry>is contained by</entry>
- <entry><literal>ARRAY[2,7] &lt;@ ARRAY[1,7,4,2,6]</literal></entry>
+ <entry><literal>ARRAY[2,2,7] &lt;@ ARRAY[1,7,4,2,6]</literal></entry>
<entry><literal>t</literal></entry>
</row>
@@ -11721,8 +11721,10 @@ SELECT NULLIF(value, '(none)') ...
</table>
<para>
- Array comparisons compare the array contents element-by-element,
- using the default B-tree comparison function for the element data type.
+ The array ordering operators (<literal>&lt;</literal>,
+ <literal>&gt;=</literal>, etc) compare the array contents
+ element-by-element, using the default B-tree comparison function for
+ the element data type, and sort based on the first difference.
In multidimensional arrays the elements are visited in row-major order
(last subscript varies most rapidly).
If the contents of two arrays are equal but the dimensionality is
@@ -11734,6 +11736,15 @@ SELECT NULLIF(value, '(none)') ...
</para>
<para>
+ The array containment operators (<literal>&lt;@</literal>
+ and <literal>@&gt;</literal>) consider one array to be contained in
+ another one if each of its elements appears in the other one.
+ Duplicates are not treated specially, thus <literal>ARRAY[1]</literal>
+ and <literal>ARRAY[1,1]</literal> are each considered to contain the
+ other.
+ </para>
+
+ <para>
See <xref linkend="arrays"> for more details about array operator
behavior. See <xref linkend="indexes-types"> for more details about
which operators support indexed operations.