magic-removal: Refs #1219 -- added documentation for bulk delete feature.

git-svn-id: http://code.djangoproject.com/svn/django/branches/magic-removal@2048 bcc190cf-cafb-0310-a4f2-bffc1f526a37

1 files changed, 16 insertions, 0 deletions

diff --git a/docs/db-api.txt b/docs/db-api.txt
index 5261ab6fda..1fe77ebfb0 100644
--- a/docs/db-api.txt
+++ b/docs/db-api.txt
@@ -544,6 +544,22 @@ deletes the object and has no return value. Example::
 
     >>> c.delete()
 
+Objects can also be deleted in bulk using the same query parameters that are 
+used for get_object and other query methods. For example:: 
+
+    >>> Polls.objects.delete(pub_date__year=2005)
+
+would bulk delete all Polls with a year of 2005. A bulk delete call with no
+parameters would theoretically delete all data in the table. To prevent 
+accidental obliteration of a database, a bulk delete query with no parameters
+will throw an exception. If you actually want to delete all the data in a 
+table, you must add a ``DELETE_ALL=True`` argument to your query. 
+For example::
+
+    >>> Polls.objects.delete(DELETE_ALL=True)
+
+would remove all Poll instances from the database.
+
 Comparing objects
 =================