Doc'd BaseConstraint.

This commit is contained in:
Gagaro 2022-03-16 16:05:12 +01:00 committed by Mariusz Felisiak
parent 4bd494db42
commit 9c04af837a
2 changed files with 19 additions and 17 deletions

View File

@ -32,7 +32,7 @@ PostgreSQL supports additional data integrity constraints available from the
.. attribute:: ExclusionConstraint.name .. attribute:: ExclusionConstraint.name
The name of the constraint. See :attr:`.BaseConstraint.name`.
``expressions`` ``expressions``
--------------- ---------------

View File

@ -42,6 +42,24 @@ option.
also raised during model validation when the ``UniqueConstraint`` is also raised during model validation when the ``UniqueConstraint`` is
violated. violated.
``BaseConstraint``
==================
.. class:: BaseConstraint(name)
Base class for all constraints. Subclasses must implement
``constraint_sql()``, ``create_sql()``, and ``remove_sql()`` methods.
All constraints have the following parameters in common:
``name``
--------
.. attribute:: BaseConstraint.name
The name of the constraint. You must always specify a unique name for the
constraint.
``CheckConstraint`` ``CheckConstraint``
=================== ===================
@ -60,14 +78,6 @@ specifies the check you want the constraint to enforce.
For example, ``CheckConstraint(check=Q(age__gte=18), name='age_gte_18')`` For example, ``CheckConstraint(check=Q(age__gte=18), name='age_gte_18')``
ensures the age field is never less than 18. ensures the age field is never less than 18.
``name``
--------
.. attribute:: CheckConstraint.name
The name of the constraint. You must always specify a unique name for the
constraint.
``UniqueConstraint`` ``UniqueConstraint``
==================== ====================
@ -107,14 +117,6 @@ For example, ``UniqueConstraint(fields=['room', 'date'],
name='unique_booking')`` ensures each room can only be booked once for each name='unique_booking')`` ensures each room can only be booked once for each
date. date.
``name``
--------
.. attribute:: UniqueConstraint.name
The name of the constraint. You must always specify a unique name for the
constraint.
``condition`` ``condition``
------------- -------------