diff options
| author | Simon Charette <charette.s@gmail.com> | 2018-08-05 22:30:44 -0400 |
|---|---|---|
| committer | Tim Graham <timograham@gmail.com> | 2018-11-13 17:57:27 -0500 |
| commit | 8eae094638acf802c8047b341d126d94bc9b45a3 (patch) | |
| tree | 7d351d2a90ba105067eb2b82f4341afaa9423de0 /docs/ref | |
| parent | d0af5de12238154fe15cd12efec6e056186e519b (diff) | |
Generalized check constraint docs for other constraints.
Diffstat (limited to 'docs/ref')
| -rw-r--r-- | docs/ref/models/constraints.txt (renamed from docs/ref/models/check-constraints.txt) | 19 | ||||
| -rw-r--r-- | docs/ref/models/index.txt | 2 | ||||
| -rw-r--r-- | docs/ref/models/options.txt | 4 |
3 files changed, 12 insertions, 13 deletions
diff --git a/docs/ref/models/check-constraints.txt b/docs/ref/models/constraints.txt index 06ddd26b54..9e24a1cad8 100644 --- a/docs/ref/models/check-constraints.txt +++ b/docs/ref/models/constraints.txt @@ -1,6 +1,6 @@ -=========================== -Check constraints reference -=========================== +===================== +Constraints reference +===================== .. module:: django.db.models.constraints @@ -8,20 +8,19 @@ Check constraints reference .. versionadded:: 2.2 -The ``CheckConstraint`` class creates database check constraints. They are -added in the model :attr:`Meta.constraints -<django.db.models.Options.constraints>` option. This document -explains the API references of :class:`CheckConstraint`. +The classes defined in this module create database constraints. They are added +in the model :attr:`Meta.constraints <django.db.models.Options.constraints>` +option. .. admonition:: Referencing built-in constraints Constraints are defined in ``django.db.models.constraints``, but for convenience they're imported into :mod:`django.db.models`. The standard convention is to use ``from django.db import models`` and refer to the - constraints as ``models.CheckConstraint``. + constraints as ``models.<Foo>Constraint``. -``CheckConstraint`` options -=========================== +``CheckConstraint`` +=================== .. class:: CheckConstraint(*, check, name) diff --git a/docs/ref/models/index.txt b/docs/ref/models/index.txt index c3aa5a718a..e48e138578 100644 --- a/docs/ref/models/index.txt +++ b/docs/ref/models/index.txt @@ -9,7 +9,7 @@ Model API reference. For introductory material, see :doc:`/topics/db/models`. fields indexes - check-constraints + constraints meta relations class diff --git a/docs/ref/models/options.txt b/docs/ref/models/options.txt index 6c098a8f56..4aedd4b92a 100644 --- a/docs/ref/models/options.txt +++ b/docs/ref/models/options.txt @@ -459,8 +459,8 @@ Django quotes column and table names behind the scenes. .. versionadded:: 2.2 - A list of :doc:`constraints </ref/models/check-constraints>` that you want - to define on the model:: + A list of :doc:`constraints </ref/models/constraints>` that you want to + define on the model:: from django.db import models |