From d58020fce8019e3a9df717e0a78a9833c85094b7 Mon Sep 17 00:00:00 2001 From: Justin Bronn Date: Sat, 20 Mar 2010 05:04:31 +0000 Subject: [PATCH] Fixed `fieldlookup` docs cross-reference directive, and added it to the queryset reference. Refs #12930. git-svn-id: http://code.djangoproject.com/svn/django/trunk@12808 bcc190cf-cafb-0310-a4f2-bffc1f526a37 --- docs/_ext/djangodocs.py | 2 +- docs/ref/models/querysets.txt | 44 +++++++++++++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 1 deletion(-) diff --git a/docs/_ext/djangodocs.py b/docs/_ext/djangodocs.py index af07a84f32..aaad219b54 100644 --- a/docs/_ext/djangodocs.py +++ b/docs/_ext/djangodocs.py @@ -38,7 +38,7 @@ def setup(app): app.add_crossref_type( directivename = "fieldlookup", rolename = "lookup", - indextemplate = "pair: %s, field lookup type", + indextemplate = "pair: %s; field lookup type", ) app.add_description_unit( directivename = "django-admin", diff --git a/docs/ref/models/querysets.txt b/docs/ref/models/querysets.txt index de8dce7a55..9b1ffc56f6 100644 --- a/docs/ref/models/querysets.txt +++ b/docs/ref/models/querysets.txt @@ -1191,6 +1191,8 @@ specified as keyword arguments to the ``QuerySet`` methods ``filter()``, For an introduction, see :ref:`field-lookups-intro`. +.. fieldlookup:: exact + exact ~~~~~ @@ -1222,6 +1224,8 @@ SQL equivalents:: information about this, see the :ref:`collation section ` in the :ref:`databases ` documentation. +.. fieldlookup:: iexact + iexact ~~~~~~ @@ -1245,6 +1249,8 @@ BLoG'``, etc. comparisons. SQLite does not do case-insensitive matching for Unicode strings. +.. fieldlookup:: contains + contains ~~~~~~~~ @@ -1264,6 +1270,8 @@ Note this will match the headline ``'Today Lennon honored'`` but not SQLite doesn't support case-sensitive ``LIKE`` statements; ``contains`` acts like ``icontains`` for SQLite. +.. fieldlookup:: icontains + icontains ~~~~~~~~~ @@ -1283,6 +1291,8 @@ SQL equivalent:: mind the :ref:`database note ` about string comparisons. +.. fieldlookup:: in + in ~~ @@ -1358,6 +1368,8 @@ extract two field values, where only one is expected:: the first query. Without it, a nested query would be executed, because :ref:`querysets-are-lazy`. +.. fieldlookup:: gt + gt ~~ @@ -1371,21 +1383,29 @@ SQL equivalent:: SELECT ... WHERE id > 4; +.. fieldlookup:: gte + gte ~~~ Greater than or equal to. +.. fieldlookup:: lt + lt ~~ Less than. +.. fieldlookup:: lte + lte ~~~ Less than or equal to. +.. fieldlookup:: startswith + startswith ~~~~~~~~~~ @@ -1402,6 +1422,8 @@ SQL equivalent:: SQLite doesn't support case-sensitive ``LIKE`` statements; ``startswith`` acts like ``istartswith`` for SQLite. +.. fieldlookup:: istartswith + istartswith ~~~~~~~~~~~ @@ -1421,6 +1443,8 @@ SQL equivalent:: mind the :ref:`database note ` about string comparisons. +.. fieldlookup:: endswith + endswith ~~~~~~~~ @@ -1437,6 +1461,8 @@ SQL equivalent:: SQLite doesn't support case-sensitive ``LIKE`` statements; ``endswith`` acts like ``iendswith`` for SQLite. +.. fieldlookup:: iendswith + iendswith ~~~~~~~~~ @@ -1456,6 +1482,8 @@ SQL equivalent:: mind the :ref:`database note ` about string comparisons. +.. fieldlookup:: range + range ~~~~~ @@ -1474,6 +1502,8 @@ SQL equivalent:: You can use ``range`` anywhere you can use ``BETWEEN`` in SQL -- for dates, numbers and even characters. +.. fieldlookup:: year + year ~~~~ @@ -1489,6 +1519,8 @@ SQL equivalent:: (The exact SQL syntax varies for each database engine.) +.. fieldlookup:: month + month ~~~~~ @@ -1505,6 +1537,8 @@ SQL equivalent:: (The exact SQL syntax varies for each database engine.) +.. fieldlookup:: day + day ~~~ @@ -1523,6 +1557,8 @@ SQL equivalent:: Note this will match any record with a pub_date on the third day of the month, such as January 3, July 3, etc. +.. fieldlookup:: week_day + week_day ~~~~~~~~ @@ -1544,6 +1580,8 @@ Note this will match any record with a pub_date that falls on a Monday (day 2 of the week), regardless of the month or year in which it occurs. Week days are indexed with day 1 being Sunday and day 7 being Saturday. +.. fieldlookup:: isnull + isnull ~~~~~~ @@ -1558,6 +1596,8 @@ SQL equivalent:: SELECT ... WHERE pub_date IS NULL; +.. fieldlookup:: search + search ~~~~~~ @@ -1577,6 +1617,8 @@ database to add the full-text index. By default Django uses BOOLEAN MODE for full text searches. `Please check MySQL documentation for additional details. `_ +.. fieldlookup:: regex + regex ~~~~~ @@ -1606,6 +1648,8 @@ SQL equivalents:: Using raw strings (e.g., ``r'foo'`` instead of ``'foo'``) for passing in the regular expression syntax is recommended. +.. fieldlookup:: iregex + iregex ~~~~~~