summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFloris den Hengst <florisdenhengst@gmail.com>2015-03-07 18:45:57 +0100
committerTim Graham <timograham@gmail.com>2015-03-09 20:46:26 -0400
commit9853844ed3d3d25954205ce1b53962b57fef3d5e (patch)
treee372fae8112f5bb331f9c0186674b4eea3b3f546 /docs
parentffa4ff5e8cda9f6653915d435ab4381723e8112a (diff)
[1.8.x] Fixed #24432 -- Added docs for ManyToManyFields that reside in and refer to the same model.
Backport of b9b8411129efe13642cef1fc6bbfc62bed717352 from master
Diffstat (limited to 'docs')
-rw-r--r--docs/ref/models/fields.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 8702987630..192b8f8f4e 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1422,7 +1422,10 @@ that control how the relationship functions.
If you don't specify an explicit ``through`` model, there is still an
implicit ``through`` model class you can use to directly access the table
- created to hold the association. It has three fields:
+ created to hold the association. It has three fields to link the models.
+
+ If the source and target models differ, the following fields are
+ generated:
* ``id``: the primary key of the relation.
* ``<containing_model>_id``: the ``id`` of the model that declares the
@@ -1430,6 +1433,15 @@ that control how the relationship functions.
* ``<other_model>_id``: the ``id`` of the model that the
``ManyToManyField`` points to.
+ If the ``ManyToManyField`` points from and to the same model, the following
+ fields are generated:
+
+ * ``id``: the primary key of the relation.
+ * ``from_<model>_id``: the ``id`` of the instance which points at the
+ model (i.e. the source instance).
+ * ``to_<model>_id``: the ``id`` of the instance to which the relationship
+ points (i.e. the target model instance).
+
This class can be used to query associated records for a given model
instance like a normal model.