summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorHannes Ljungberg <hannes@5monkeys.se>2020-06-11 21:05:38 +0200
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2020-06-12 23:23:21 +0200
commite0cdd0fcf5f677b588f63b40b801e42e2ee3786d (patch)
tree2882583cb6e81707ba0fe2110b65cbd27a980b5e /docs/ref
parentdb8268bce69fb53b7be4be90a2d7200c12019b90 (diff)
Fixed #31649 -- Added support for covering exclusion constraints on PostgreSQL 12+.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/postgres/constraints.txt17
1 files changed, 16 insertions, 1 deletions
diff --git a/docs/ref/contrib/postgres/constraints.txt b/docs/ref/contrib/postgres/constraints.txt
index f90667c394..fdc547265e 100644
--- a/docs/ref/contrib/postgres/constraints.txt
+++ b/docs/ref/contrib/postgres/constraints.txt
@@ -12,7 +12,7 @@ PostgreSQL supports additional data integrity constraints available from the
``ExclusionConstraint``
=======================
-.. class:: ExclusionConstraint(*, name, expressions, index_type=None, condition=None, deferrable=None)
+.. class:: ExclusionConstraint(*, name, expressions, index_type=None, condition=None, deferrable=None, include=None)
Creates an exclusion constraint in the database. Internally, PostgreSQL
implements exclusion constraints using indexes. The default index type is
@@ -106,6 +106,21 @@ enforced immediately after every command.
Deferred exclusion constraints may lead to a `performance penalty
<https://www.postgresql.org/docs/current/sql-createtable.html#id-1.9.3.85.9.4>`_.
+``include``
+-----------
+
+.. attribute:: ExclusionConstraint.include
+
+.. versionadded:: 3.2
+
+A list or tuple of the names of the fields to be included in the covering
+exclusion constraint as non-key columns. This allows index-only scans to be
+used for queries that select only included fields
+(:attr:`~ExclusionConstraint.include`) and filter only by indexed fields
+(:attr:`~ExclusionConstraint.expressions`).
+
+``include`` is supported only for GiST indexes on PostgreSQL 12+.
+
Examples
--------