Commit c06b724a authored by Tim Graham's avatar Tim Graham
Browse files

[1.4.X] Fixed #17435 - Clarified that QuerySet.update returns the number of rows matched

Backport of 6d46c740 from master
parent 0636c958
Loading
Loading
Loading
Loading
+2 −1
Original line number Diff line number Diff line
@@ -1530,7 +1530,8 @@ update
.. method:: update(**kwargs)

Performs an SQL update query for the specified fields, and returns
the number of rows affected.
the number of rows matched (which may not be equal to the number of rows
updated if some rows already have the new value).

For example, to turn comments off for all blog entries published in 2010,
you could do this::
+2 −1
Original line number Diff line number Diff line
@@ -953,7 +953,8 @@ new value to be the new model instance you want to point to. For example::
    >>> Entry.objects.all().update(blog=b)

The ``update()`` method is applied instantly and returns the number of rows
affected by the query. The only restriction on the
matched by the query (which may not be equal to the number of rows updated if
some rows already have the new value). The only restriction on the
:class:`~django.db.models.query.QuerySet` that is updated is that it can only
access one database table, the model's main table. You can filter based on
related fields, but you can only update columns in the model's main