innov
/
django1
1
0
Fork 0
Code Issues Pull Requests 1 Projects Releases Wiki Activity

[4.0.x] Corrected signatures of QuerySet's methods. 

Backport of a17becf4c7 from main
This commit is contained in:
Mariusz Felisiak 2021-11-23 07:04:04 +01:00
parent 8e5405a47e
commit 70b05c5374
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/ref/models/querysets.txt
View File

@ -179,7 +179,7 @@ executed.
``filter()`` ``filter()``
~~~~~~~~~~~~ ~~~~~~~~~~~~
.. method:: filter(**kwargs) .. method:: filter(*args, **kwargs)
Returns a new ``QuerySet`` containing objects that match the given lookup Returns a new ``QuerySet`` containing objects that match the given lookup
parameters. parameters.
@ -189,12 +189,12 @@ The lookup parameters (``**kwargs``) should be in the format described in
underlying SQL statement. underlying SQL statement.
If you need to execute more complex queries (for example, queries with ``OR`` statements), If you need to execute more complex queries (for example, queries with ``OR`` statements),
you can use :class:`Q objects <django.db.models.Q>`. you can use :class:`Q objects <django.db.models.Q>` (``*args``).
``exclude()`` ``exclude()``
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
.. method:: exclude(**kwargs) .. method:: exclude(*args, **kwargs)
Returns a new ``QuerySet`` containing objects that do *not* match the given Returns a new ``QuerySet`` containing objects that do *not* match the given
lookup parameters. lookup parameters.
@ -231,7 +231,7 @@ In SQL terms, that evaluates to:
Note the second example is more restrictive. Note the second example is more restrictive.
If you need to execute more complex queries (for example, queries with ``OR`` statements), If you need to execute more complex queries (for example, queries with ``OR`` statements),
you can use :class:`Q objects <django.db.models.Q>`. you can use :class:`Q objects <django.db.models.Q>` (``*args``).
``annotate()`` ``annotate()``
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
@ -1851,7 +1851,7 @@ raised if ``select_for_update()`` is used in autocommit mode.
``raw()`` ``raw()``
~~~~~~~~~ ~~~~~~~~~
.. method:: raw(raw_query, params=(), translations=None) .. method:: raw(raw_query, params=(), translations=None, using=None)
Takes a raw SQL query, executes it, and returns a Takes a raw SQL query, executes it, and returns a
``django.db.models.query.RawQuerySet`` instance. This ``RawQuerySet`` instance ``django.db.models.query.RawQuerySet`` instance. This ``RawQuerySet`` instance
@ -1923,7 +1923,7 @@ they query the database each time they're called.
``get()`` ``get()``
~~~~~~~~~ ~~~~~~~~~
.. method:: get(**kwargs) .. method:: get(*args, **kwargs)
Returns the object matching the given lookup parameters, which should be in Returns the object matching the given lookup parameters, which should be in
the format described in `Field lookups`_. You should use lookups that are the format described in `Field lookups`_. You should use lookups that are
@ -1931,7 +1931,7 @@ guaranteed unique, such as the primary key or fields in a unique constraint.
For example:: For example::
Entry.objects.get(id=1) Entry.objects.get(id=1)
Entry.objects.get(blog=blog, entry_number=1) Entry.objects.get(Q(blog=blog) & Q(entry_number=1))
If you expect a queryset to already return one row, you can use ``get()`` If you expect a queryset to already return one row, you can use ``get()``
without any arguments to return the object for that row:: without any arguments to return the object for that row::