summaryrefslogtreecommitdiff
path: root/docs/ref
diff options
context:
space:
mode:
authorKarl Hobley <karlhobley10@gmail.com>2015-03-16 19:28:53 +0000
committerTim Graham <timograham@gmail.com>2015-03-18 19:12:46 -0400
commita8c53041f9645df9bfa744027efb2a36867422d8 (patch)
treee123dcd1f6b0e486144f2fae349f466087a403a5 /docs/ref
parent247251c2e1702831b7ab80a69a3f7f5831be3b96 (diff)
[1.8.x] Fixed #24495 -- Allowed unsaved model instance assignment check to be bypassed.
Backport of 81e1a35c364e5353d2bf99368ad30a4184fbb653 from master
Diffstat (limited to 'docs/ref')
-rw-r--r--docs/ref/contrib/contenttypes.txt7
-rw-r--r--docs/ref/models/fields.txt32
2 files changed, 38 insertions, 1 deletions
diff --git a/docs/ref/contrib/contenttypes.txt b/docs/ref/contrib/contenttypes.txt
index 474d0a6ff1..09ee14c0fe 100644
--- a/docs/ref/contrib/contenttypes.txt
+++ b/docs/ref/contrib/contenttypes.txt
@@ -299,6 +299,13 @@ model:
is ``True``. This mirrors the ``for_concrete_model`` argument to
:meth:`~django.contrib.contenttypes.models.ContentTypeManager.get_for_model`.
+ .. attribute:: GenericForeignKey.allow_unsaved_instance_assignment
+
+ .. versionadded:: 1.8
+
+ Works analogously to :attr:`ForeignKey.allow_unsaved_instance_assignment
+ <django.db.models.ForeignKey.allow_unsaved_instance_assignment>`.
+
.. deprecated:: 1.7
This class used to be defined in ``django.contrib.contenttypes.generic``.
diff --git a/docs/ref/models/fields.txt b/docs/ref/models/fields.txt
index 372147c476..d764719705 100644
--- a/docs/ref/models/fields.txt
+++ b/docs/ref/models/fields.txt
@@ -1330,6 +1330,30 @@ The possible values for :attr:`~ForeignKey.on_delete` are found in
If in doubt, leave it to its default of ``True``.
+.. attribute:: ForeignKey.allow_unsaved_instance_assignment
+
+ .. versionadded:: 1.8
+
+ This flag was added for backwards compatibility as older versions of
+ Django always allowed assigning unsaved model instances.
+
+ Django prevents unsaved model instances from being assigned to a
+ ``ForeignKey`` field to prevent accidental data loss (unsaved foreign keys
+ are silently ignored when saving a model instance).
+
+ If you require allowing the assignment of unsaved instances and aren't
+ concerned about the data loss possibility (e.g. you never save the objects
+ to the database), you can disable this check by creating a subclass of the
+ field class and setting its ``allow_unsaved_instance_assignment`` attribute
+ to ``True``. For example::
+
+ class UnsavedForeignKey(models.ForeignKey):
+ # A ForeignKey which can point to an unsaved object
+ allow_unsaved_instance_assignment = True
+
+ class Book(models.Model):
+ author = UnsavedForeignKey(Author)
+
.. _ref-manytomany:
``ManyToManyField``
@@ -1433,7 +1457,7 @@ 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
+ If the ``ManyToManyField`` points from and to the same model, the following
fields are generated:
* ``id``: the primary key of the relation.
@@ -1532,6 +1556,12 @@ that control how the relationship functions.
If in doubt, leave it to its default of ``True``.
+.. attribute:: ManyToManyField.allow_unsaved_instance_assignment
+
+ .. versionadded:: 1.8
+
+ Works analogously to :attr:`ForeignKey.allow_unsaved_instance_assignment`.
+
:class:`ManyToManyField` does not support :attr:`~Field.validators`.
:attr:`~Field.null` has no effect since there is no way to require a