summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorHannes Ljungberg <hannes.ljungberg@gmail.com>2021-12-08 21:28:08 +0100
committerMariusz Felisiak <felisiak.mariusz@gmail.com>2021-12-27 08:55:18 +0100
commit59a66f05126a4f9622f67ac71ccc149c805a6ccd (patch)
tree40116048347c6a83dc18cffa15d1ab51f9962669 /docs/ref
parentff225fac1d129d4bcfef0aeb03df6f3b20fbb23d (diff)
Refs #33342 -- Deprecated ExclusionConstraint.opclasses.
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/postgres/constraints.txt28
1 files changed, 16 insertions, 12 deletions
diff --git a/docs/ref/contrib/postgres/constraints.txt b/docs/ref/contrib/postgres/constraints.txt
index fe7d53bb79..1ea1fcfb8f 100644
--- a/docs/ref/contrib/postgres/constraints.txt
+++ b/docs/ref/contrib/postgres/constraints.txt
@@ -53,10 +53,22 @@ operators with strings. For example::
Only commutative operators can be used in exclusion constraints.
+The :class:`OpClass() <django.contrib.postgres.indexes.OpClass>` expression can
+be used to specify a custom `operator class`_ for the constraint expressions.
+For example::
+
+ expressions=[
+ (OpClass('circle', name='circle_ops'), RangeOperators.OVERLAPS),
+ ]
+
+creates an exclusion constraint on ``circle`` using ``circle_ops``.
+
.. versionchanged:: 4.1
Support for the ``OpClass()`` expression was added.
+.. _operator class: https://www.postgresql.org/docs/current/indexes-opclass.html
+
``index_type``
--------------
@@ -147,19 +159,11 @@ For example::
creates an exclusion constraint on ``circle`` using ``circle_ops``.
-Alternatively, you can use
-:class:`OpClass() <django.contrib.postgres.indexes.OpClass>` in
-:attr:`~ExclusionConstraint.expressions`::
-
- ExclusionConstraint(
- name='exclude_overlapping_opclasses',
- expressions=[(OpClass('circle', 'circle_ops'), RangeOperators.OVERLAPS)],
- )
-
-.. versionchanged:: 4.1
+.. deprecated:: 4.1
- Support for specifying operator classes with the ``OpClass()`` expression
- was added.
+ The ``opclasses`` parameter is deprecated in favor of using
+ :class:`OpClass() <django.contrib.postgres.indexes.OpClass>` in
+ :attr:`~ExclusionConstraint.expressions`.
Examples
--------