From 26db9d8a9d18869ef4bee19454e706b94bfcb9ad Mon Sep 17 00:00:00 2001 From: Meir Kriheli Date: Thu, 7 Jun 2012 12:32:02 +0300 Subject: [PATCH] Documentation for PULL reverse_delete_rule --- docs/changelog.rst | 4 ++++ docs/guide/defining-documents.rst | 4 ++++ mongoengine/fields.py | 2 ++ 3 files changed, 10 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index 02887fd6..67b798ac 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -2,6 +2,10 @@ Changelog ========= +Changes in 0.6.x +================= +- PULL reverse_delete_rule + Changes in 0.6.10 ================= - Fixed basedict / baselist to return super(..) diff --git a/docs/guide/defining-documents.rst b/docs/guide/defining-documents.rst index ba7a5801..a005ddd3 100644 --- a/docs/guide/defining-documents.rst +++ b/docs/guide/defining-documents.rst @@ -289,6 +289,10 @@ Its value can take any of the following constants: :const:`mongoengine.CASCADE` Any object containing fields that are refererring to the object being deleted are deleted first. +:const:`mongoengine.PULL` + Removes the reference to the object (using MongoDB's "pull" operation) + from any object's fields of + :class:`~mongoengine.ListField` (:class:`~mongoengine.ReferenceField`). .. warning:: diff --git a/mongoengine/fields.py b/mongoengine/fields.py index c72c6cb4..df10d33e 100644 --- a/mongoengine/fields.py +++ b/mongoengine/fields.py @@ -656,6 +656,8 @@ class ReferenceField(BaseField): * NULLIFY - Updates the reference to null. * CASCADE - Deletes the documents associated with the reference. * DENY - Prevent the deletion of the reference object. + * PULL - Pull the reference from a :class:`~mongoengine.ListField` + of references Alternative syntax for registering delete rules (useful when implementing bi-directional delete rules)