From 4ed3d57184169541f0ba55549759769020827bf8 Mon Sep 17 00:00:00 2001
From: Georg Bauer <gb@hugo.westfalen.de>
Date: Sun, 4 Dec 2005 14:04:56 +0000
Subject: [PATCH] added documentation for the query kwargs introduced by [1534]

git-svn-id: http://code.djangoproject.com/svn/django/trunk@1536 bcc190cf-cafb-0310-a4f2-bffc1f526a37
---
 docs/db-api.txt | 84 ++++++++++++++++++++++++++-----------------------
 1 file changed, 45 insertions(+), 39 deletions(-)

diff --git a/docs/db-api.txt b/docs/db-api.txt
index 3cee4d6c6e..a1fd8b147b 100644
--- a/docs/db-api.txt
+++ b/docs/db-api.txt
@@ -152,45 +152,51 @@ translates (roughly) into the following SQL::
 
 The DB API supports the following lookup types:
 
-    ===========  ==============================================================
-    Type         Description
-    ===========  ==============================================================
-    exact        Exact match: ``polls.get_object(id__exact=14)``.
-    iexact       Case-insensitive exact match:
-                 ``polls.get_list(slug__iexact="foo")`` matches a slug of
-                 ``foo``, ``FOO``, ``fOo``, etc.
-    contains     Case-sensitive containment test:
-                 ``polls.get_list(question__contains="spam")`` returns all polls
-                 that contain "spam" in the question. (PostgreSQL and MySQL
-                 only. SQLite doesn't support case-sensitive LIKE statements;
-                 ``contains`` will act like ``icontains`` for SQLite.)
-    icontains    Case-insensitive containment test.
-    gt           Greater than: ``polls.get_list(id__gt=4)``.
-    gte          Greater than or equal to.
-    lt           Less than.
-    lte          Less than or equal to.
-    ne           Not equal to.
-    in           In a given list: ``polls.get_list(id__in=[1, 3, 4])`` returns
-                 a list of polls whose IDs are either 1, 3 or 4.
-    startswith   Case-sensitive starts-with:
-                 ``polls.get_list(question_startswith="Would")``. (PostgreSQL
-                 and MySQL only. SQLite doesn't support case-sensitive LIKE
-                 statements; ``startswith`` will act like ``istartswith`` for
-                 SQLite.)
-    endswith     Case-sensitive ends-with. (PostgreSQL and MySQL only.)
-    istartswith  Case-insensitive starts-with.
-    iendswith    Case-insensitive ends-with.
-    range        Range test:
-                 ``polls.get_list(pub_date__range=(start_date, end_date))``
-                 returns all polls with a pub_date between ``start_date``
-                 and ``end_date`` (inclusive).
-    year         For date/datetime fields, exact year match:
-                 ``polls.get_count(pub_date__year=2005)``.
-    month        For date/datetime fields, exact month match.
-    day          For date/datetime fields, exact day match.
-    isnull       True/False; does is IF NULL/IF NOT NULL lookup:
-                 ``polls.get_list(expire_date__isnull=True)``.
-    ===========  ==============================================================
+    =============  ==============================================================
+    Type           Description
+    =============  ==============================================================
+    exact          Exact match: ``polls.get_object(id__exact=14)``.
+    iexact         Case-insensitive exact match:
+                   ``polls.get_list(slug__iexact="foo")`` matches a slug of
+                   ``foo``, ``FOO``, ``fOo``, etc.
+    contains       Case-sensitive containment test:
+                   ``polls.get_list(question__contains="spam")`` returns all polls
+                   that contain "spam" in the question. (PostgreSQL and MySQL
+                   only. SQLite doesn't support case-sensitive LIKE statements;
+                   ``contains`` will act like ``icontains`` for SQLite.)
+    notcontains    negated ``contains``
+    icontains      Case-insensitive containment test.
+    inotcontains   negated ``icontains``
+    gt             Greater than: ``polls.get_list(id__gt=4)``.
+    gte            Greater than or equal to.
+    lt             Less than.
+    lte            Less than or equal to.
+    ne             Not equal to.
+    in             In a given list: ``polls.get_list(id__in=[1, 3, 4])`` returns
+                   a list of polls whose IDs are either 1, 3 or 4.
+    startswith     Case-sensitive starts-with:
+                   ``polls.get_list(question_startswith="Would")``. (PostgreSQL
+                   and MySQL only. SQLite doesn't support case-sensitive LIKE
+                   statements; ``startswith`` will act like ``istartswith`` for
+                   SQLite.)
+    notstartswith  negated ``startswith``
+    endswith       Case-sensitive ends-with. (PostgreSQL and MySQL only.)
+    notendswith    negated ``endswith``
+    istartswith    Case-insensitive starts-with.
+    inotstartswith negated ``istartswith``
+    iendswith      Case-insensitive ends-with.
+    inotendswith   negated ``iendswith``
+    range          Range test:
+                   ``polls.get_list(pub_date__range=(start_date, end_date))``
+                   returns all polls with a pub_date between ``start_date``
+                   and ``end_date`` (inclusive).
+    year           For date/datetime fields, exact year match:
+                   ``polls.get_count(pub_date__year=2005)``.
+    month          For date/datetime fields, exact month match.
+    day            For date/datetime fields, exact day match.
+    isnull         True/False; does is IF NULL/IF NOT NULL lookup:
+                   ``polls.get_list(expire_date__isnull=True)``.
+    =============  ==============================================================
 
 Multiple lookups are allowed, of course, and are translated as "AND"s::