Browse Source

Doc'd BaseConstraint.

Gagaro 3 years ago
parent
commit
9c04af837a
2 changed files with 19 additions and 17 deletions
  1. 1 1
      docs/ref/contrib/postgres/constraints.txt
  2. 18 16
      docs/ref/models/constraints.txt

+ 1 - 1
docs/ref/contrib/postgres/constraints.txt

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

+ 18 - 16
docs/ref/models/constraints.txt

@@ -42,6 +42,24 @@ option.
     also raised during model validation when the ``UniqueConstraint`` is
     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``
 ===================
 
@@ -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')``
 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``
 ====================
 
@@ -107,14 +117,6 @@ For example, ``UniqueConstraint(fields=['room', 'date'],
 name='unique_booking')`` ensures each room can only be booked once for each
 date.
 
-``name``
---------
-
-.. attribute:: UniqueConstraint.name
-
-The name of the constraint. You must always specify a unique name for the
-constraint.
-
 ``condition``
 -------------