[Django] #32381: Include number of rows matched in bulk

Django

unread,

Jan 23, 2021, 5:04:32 PM1/23/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------
Reporter: Chris | Owner: nobody
Jerdonek |
Type: New | Status: new
feature |
Component: Database | Version: master
layer (models, ORM) |
Severity: Normal | Keywords: bulk_update
Triage Stage: | Has patch: 0
Unreviewed |
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Currently, `bulk_update()` returns `None`, unlike `update()`, which
returns
[https://docs.djangoproject.com/en/3.2/ref/models/querysets/#django.db.models.query.QuerySet.update
the number of rows matched].

It looks like it would be easy to add the same functionality to
`bulk_update()` since `bulk_update()` simply calls `update()` repeatedly:
https://github.com/django/django/blob/2b4b6c8af0aae8785bc1347cf1be2e8e70fd5ff3/django/db/models/query.py#L568
I.e. the return values could simply be added and returned.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,

Jan 23, 2021, 5:09:48 PM1/23/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Chris Jerdonek):

Also, if this feature is okayed, maybe the number could be returned in a
way that would permit other useful numbers to be added to the return value
in a backwards-compatible way later on. For example, the number could be
returned as a property of a named tuple with one property. That way, if a
new value is requested in the future, it could be added by adding a new
property to the named tuple.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:1>

Django

unread,

Jan 25, 2021, 12:42:36 AM1/25/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Keywords: bulk_update | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* cc: Tom Forbes (added)
* stage: Unreviewed => Accepted

Comment:

> Also, if this feature is okayed, maybe the number could be returned in a
way that would permit other useful numbers to be added to the return value
in a backwards-compatible way later on. For example, the number could be
returned as a property of a named tuple with one property. That way, if a
new value is requested in the future, it could be added by adding a new
property to the named tuple.

Do you have any specific statistics in mind?

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:2>

Django

unread,

Jan 25, 2021, 10:45:16 PM1/25/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Chris Jerdonek):

Thanks.

Do you have any specific statistics in mind?

Not especially, but more because I don't know what might be available. The
only things that occur to me right now are things like the number of
queries made, and the batch size used for the function call. More
usefully, though, if `update()` were ever to grow the ability to report
not just the number of rows matched but also the number of rows changed,
that would definitely be of interest.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:3>

Django

unread,

Jan 25, 2021, 11:43:28 PM1/25/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Simon Charette):

> More usefully, though, if update() were ever to grow the ability to

report not just the number of rows matched but also the number of rows

changed, that would definitely be of interest.

Given that would likely require a signature change to `update` if we ever
want to support it I think that making `bulk_update` return the sums of
its `update`s should be good enough for now.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:4>

Django

unread,

Jan 26, 2021, 7:57:41 AM1/26/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Tom Forbes):

I would second that: it’s good to be future proof, but we’re somewhat
locked in to the current returned result due to update. Let’s just make it
return the updated rows, which seems like a simple and sensible change.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:5>

Django

unread,

Jan 26, 2021, 7:58:10 AM1/26/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Tom Forbes):

* easy: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:6>

Django

unread,

Jan 27, 2021, 5:31:43 AM1/27/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Reporter: Chris Jerdonek | Owner: Manav
| Agarwal
Type: New feature | Status: assigned

Component: Database layer | Version: master
(models, ORM) |
Severity: Normal | Resolution:
Keywords: bulk_update | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Manav Agarwal):

* owner: nobody => Manav Agarwal
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:7>

Django

unread,

Jan 27, 2021, 6:55:23 AM1/27/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Tim McCurrach):

I took a look at this yesterday and due to the way bulk_update treats
duplicates in `objs` this might not be quite so straight forward as simply
summing the returned values from repeated `update()` calls. Duplicates
split between batches will be counted twice.

See https://code.djangoproject.com/ticket/32388

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:8>

Django

unread,

Feb 4, 2021, 3:24:25 AM2/4/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Chris Jerdonek):

There is now an (accepted) issue #32406 to make `update()` return
something different. Given that, might it make sense to reconsider making
`bulk_update()` future-proof now?

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:9>

Django

unread,

Feb 4, 2021, 10:36:37 AM2/4/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Simon Charette):

`update` will keep returning `int` unless `returning` is specified
otherwise it would break backward compatibility.

Can't this ticket be dedicated to having `bulk_update` returning `int`
when `returning` is not specified?

I don't see what needs to be made here to make `bulk_update` future proof?
How does making `bulk_update -> int` prevent us from having
`bulk_update(returning) -> list` match the signature of `update(returning)
-> list` in the future?

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:10>

Django

unread,

Feb 4, 2021, 11:07:38 PM2/4/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Reporter: Chris Jerdonek | Owner:
| bhavikabadjate901

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by bhavikabadjate901):

* owner: Manav Agarwal => bhavikabadjate901

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:11>

Django

unread,

Feb 4, 2021, 11:08:10 PM2/4/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by bhavikabadjate901):

assign to bhavikabadjate901

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:12>

Django

unread,

Mar 14, 2021, 11:16:19 AM3/14/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Reporter: Chris Jerdonek | Owner: Diego
| Lima

Type: New feature | Status: assigned

Component: Database layer | Version: dev

(models, ORM) |
Severity: Normal | Resolution:
Keywords: bulk_update | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Diego Lima):

* cc: Diego Lima (added)
* owner: bhavikabadjate901 => Diego Lima

Comment:

Due to inactivity, I'm claiming this ticket. [comment:11
bhavikabadjate901] please come forward if you have done any work on this!

I'm taking the simplest approach first, which is `bulk_update -> int`. As
stated by [comment:4 Simon Charette]:

> I think that making `bulk_update` return the sums of its `update`s
should be good enough for now.

and [comment:5 Tom Forbes]:

> Let’s just make it return the updated rows

Then, I'll stop and think a bit more about [comment:1 Chris Jerdonek]'s
future-proofing and [comment:8 Tim McCurrach]'s duplicate edge case.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:13>

Django

unread,

Mar 14, 2021, 11:30:20 AM3/14/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Diego Lima):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:14>

Django

unread,

Mar 14, 2021, 5:41:46 PM3/14/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 1

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Nick Pope):

* needs_docs: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:15>

Django

unread,

Mar 14, 2021, 8:50:15 PM3/14/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Nick Pope):

* needs_docs: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:16>

Django

unread,

Mar 14, 2021, 8:55:08 PM3/14/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Diego Lima):

PR ready for review at [https://github.com/django/django/pull/14125]. I
did not handle duplicates, and did not future-proof `bulk_update`.

I'm keeping an eye on #32406. If it gets patched, I'll update the returned
value on `bulk_update`. If we pin down an API that is generally agreed
upon, I might claim that ticket as well.

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:17>

Django

unread,

Mar 23, 2021, 2:41:20 AM3/23/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0
Needs tests: 1 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1
* needs_tests: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:18>

Django

unread,

Jun 25, 2021, 6:49:38 PM6/25/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Reporter: Chris Jerdonek | Owner: Abhyudai

Changes (by Abhyudai):

* owner: Diego Lima => Abhyudai

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:19>

Django

unread,

Jun 26, 2021, 2:13:27 AM6/26/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Comment (by Abhyudai):

new [https://github.com/django/django/pull/14559/ pull request]

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:20>

Django

unread,

Jun 28, 2021, 12:00:28 AM6/28/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak):

* needs_better_patch: 1 => 0
* needs_tests: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:21>

Django

unread,

Jun 28, 2021, 4:55:53 AM6/28/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 1

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:22>

Django

unread,

Jun 29, 2021, 12:21:29 AM6/29/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Keywords: bulk_update | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Mariusz Felisiak):

* needs_better_patch: 1 => 0
* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:23>

Django

unread,

Jun 29, 2021, 1:41:21 AM6/29/21

to django-...@googlegroups.com

#32381: Include number of rows matched in bulk_update() return value
-------------------------------------+-------------------------------------

Reporter: Chris Jerdonek | Owner: Abhyudai

Type: New feature | Status: closed

Component: Database layer | Version: dev
(models, ORM) |

Severity: Normal | Resolution: fixed

Keywords: bulk_update | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Mariusz Felisiak <felisiak.mariusz@…>):

* status: assigned => closed
* resolution: => fixed

Comment:

In [changeset:"cd124295d882e13cff556fdeb78e6278d10ac6d5" cd12429]:
{{{
#!CommitTicketReference repository=""
revision="cd124295d882e13cff556fdeb78e6278d10ac6d5"
Fixed #32381 -- Made QuerySet.bulk_update() return the number of objects
updated.

Co-authored-by: Diego Lima <diego...@lais.huol.ufrn.br>
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32381#comment:24>

Reply all

Reply to author

Forward

[Django] #32381: Include number of rows matched in bulk_update() return value

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django

Django