starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Specify ordering for querysets using annotate() to count related objects #3872

New Issue
Closed
opened 2025-12-29 18:31:43 +01:00 by adam · 0 comments
adam commented 2025-12-29 18:31:43 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Jul 20, 2020).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Append order_by() to every queryset which annotates a count of one or more related objects. For example:

Provider.objects.annotate(count_circuits=Count('circuits'))

becomes

Provider.objects.annotate(count_circuits=Count('circuits')).order_by(*Provider._meta.ordering)

Note: This change is not needed for MPTT models, as they are ordered according to the tree.

Justification

Django 3.1 ignores a model's default ordering when a GROUP BY clause is present in the query. Because we can't currently switch to using subqueries everywhere without breaking caching (see Suor/django-cacheops#365), we need to specify ordering manually to preserve the current behavior.

This can be reversed in the future under #4865.

Originally created by @jeremystretch on GitHub (Jul 20, 2020). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Append `order_by()` to every queryset which annotates a count of one or more related objects. For example: ```python Provider.objects.annotate(count_circuits=Count('circuits')) ``` becomes ```python Provider.objects.annotate(count_circuits=Count('circuits')).order_by(*Provider._meta.ordering) ``` **Note:** This change is _not_ needed for MPTT models, as they are ordered according to the tree. ### Justification Django 3.1 [ignores a model's default ordering](https://docs.djangoproject.com/en/3.0/topics/db/aggregation/#aggregation-ordering-interaction) when a `GROUP BY` clause is present in the query. Because we can't currently switch to using subqueries everywhere without breaking caching (see Suor/django-cacheops#365), we need to specify ordering manually to preserve the current behavior. This can be reversed in the future under #4865.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 18:31:43 +01:00
adam closed this issue 2025-12-29 18:31:43 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label status: accepted type: housekeeping
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3872
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?