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

Ensure database indexes are created for all generic foreign keys #7662

New Issue
Closed
opened 2025-12-29 20:26:35 +01:00 by adam · 0 comments
adam commented 2025-12-29 20:26:35 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 20, 2023).

Originally assigned to: @jeremystretch on GitHub.

Proposed Changes

Audit all NetBox models and ensure that appropriate PostgreSQL indexes have been created for the combination of content type and object ID wherever generic foreign keys are in use.

Justification

This was prompted by #11775, which identified the absence of an index for cached search values as a performance detractor. Per the Django docs:

Unlike for the ForeignKey, a database index is not automatically created on the GenericForeignKey, so it’s recommended that you use Meta.indexes to add your own multiple column index.

Originally created by @jeremystretch on GitHub (Feb 20, 2023). Originally assigned to: @jeremystretch on GitHub. ### Proposed Changes Audit all NetBox models and ensure that appropriate PostgreSQL indexes have been created for the combination of content type and object ID wherever generic foreign keys are in use. ### Justification This was prompted by #11775, which identified the absence of an index for cached search values as a performance detractor. Per [the Django docs](https://docs.djangoproject.com/en/4.1/ref/contrib/contenttypes/#django.contrib.contenttypes.fields.GenericForeignKey): > Unlike for the [ForeignKey](https://docs.djangoproject.com/en/4.1/ref/models/fields/#django.db.models.ForeignKey), a database index is not automatically created on the [GenericForeignKey](https://docs.djangoproject.com/en/4.1/ref/contrib/contenttypes/#django.contrib.contenttypes.fields.GenericForeignKey), so it’s recommended that you use [Meta.indexes](https://docs.djangoproject.com/en/4.1/ref/models/options/#django.db.models.Options.indexes) to add your own multiple column index.
adam added the status: acceptedtype: housekeeping labels 2025-12-29 20:26:35 +01:00
adam closed this issue 2025-12-29 20:26:35 +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#7662
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?