Commit 6f9ba54b authored by Russell Keith-Magee's avatar Russell Keith-Magee
Browse files

Fixed #12519 -- Corrected documentation on .raw() queries. Thanks to boralyl...

Fixed #12519 -- Corrected documentation on .raw() queries. Thanks to boralyl for the report and patch.

git-svn-id: http://code.djangoproject.com/svn/django/trunk@12561 bcc190cf-cafb-0310-a4f2-bffc1f526a37
parent d7927377
Loading
Loading
Loading
Loading
+10 −6
Original line number Diff line number Diff line
@@ -25,8 +25,10 @@ return model instances:

.. method:: Manager.raw(raw_query, params=None, translations=None)

This method method takes a raw SQL query, executes it, and returns model
instances.
This method method takes a raw SQL query, executes it, and returns a
:class:`~django.db.models.query.RawQuerySet` instance. This
:class:`~django.db.models.query.RawQuerySet` instance can be iterated
over just like an normal QuerySet to provide object instances.

This is best illustrated with an example. Suppose you've got the following model::

@@ -37,8 +39,10 @@ This is best illustrated with an example. Suppose you've got the following model

You could then execute custom SQL like so::

    >>> Person.objects.raw('SELECT * from myapp_person')
    [<Person: John Doe>, <Person: Jane Doe>, ...]
    >>> for p in Person.objects.raw('SELECT * FROM myapp_person'):
    ...     print p
    John Smith
    Jane Jones

.. admonition:: Model table names

@@ -110,7 +114,7 @@ Deferring model fields

Fields may also be left out::

    >>> people = Person.objects.raw('SELECT id, first_name FROM myapp_person'):
    >>> people = Person.objects.raw('SELECT id, first_name FROM myapp_person')

The ``Person`` objects returned by this query will be :ref:`deferred
<queryset-defer>` model instances. This means that the fields that are omitted