Ensure SQL indexes exist on all tables for each model's default ordering #336

New Issue

MrUnknownDE · 2026-04-05T16:26:29+02:00

MrUnknownDE commented

2026-04-05 16:26:29 +02:00

Originally created by @jeremystretch on 2/17/2026

NetBox Version

v4.5.3

Python Version

3.12

Area(s) of Concern

User Interface
REST API
GraphQL API
Python ORM
Other

Details

To improve general read query performance, we should ensure that PostgreSQL indexes matching the default ordering for each model exist on each table.

For example, the Prefix model specifies

ordering = (F('vrf').asc(nulls_first=True), 'prefix', 'pk')

We can add an index to service this:

CREATE INDEX ON ipam_prefix (vrf_id NULLS FIRST, prefix, id);

A quick benchmark with ~200K prefixes shows that the addition of this index virtually eliminates first-page query time, and reduces response time by roughly 80% for last-page queries.

Performance is sure to vary by model, but there are likely many cases where we can reap similar substantial improvements.

*Originally created by @jeremystretch on 2/17/2026* ### NetBox Version v4.5.3 ### Python Version 3.12 ### Area(s) of Concern - [ ] User Interface - [ ] REST API - [ ] GraphQL API - [ ] Python ORM - [x] Other ### Details To improve general read query performance, we should ensure that PostgreSQL indexes matching the default ordering for each model exist on each table. For example, the Prefix model specifies ```python ordering = (F('vrf').asc(nulls_first=True), 'prefix', 'pk') ``` We can add an index to service this: ```sql CREATE INDEX ON ipam_prefix (vrf_id NULLS FIRST, prefix, id); ``` A quick benchmark with ~200K prefixes shows that the addition of this index virtually eliminates first-page query time, and reduces response time by roughly 80% for last-page queries. Performance is sure to vary by model, but there are likely many cases where we can reap similar substantial improvements.

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

No Label complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low complexity: low netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox netbox status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted status: accepted type: performance type: performance type: performance type: performance type: performance type: performance type: performance

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#336