Order global search results by value of matched fields #8745

New Issue

adam · 2025-12-29T20:40:41+01:00

adam commented

2025-12-29 20:40:41 +01:00

Originally created by @jeremystretch on GitHub (Oct 13, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.6.3

Feature type

Change to existing functionality

Proposed functionality

When returning global search results, order results of equal precedence and object type by value. This should ensure that otherwise equally-relevant results appear in a human-friendly order.

The current ordering for cached search result objects is:

class CachedValue:
    class Meta:
        ordering = ('weight', 'object_type', 'object_id')

This FR would modify the above to:

class CachedValue:
    class Meta:
        ordering = ('weight', 'object_type', 'value', 'object_id')

(object_id is retained as a tie-breaker for results having the same matched value, to ensure deterministic ordering.)

Use case

This adjustment serves to ensure otherwise equally-relevant search results are listed in a human-friendly order. (This was first raised as a bug report under #13940.)

Database changes

This will require a model migration to effect the new default ordering for CachedValue.

External dependencies

None

Originally created by @jeremystretch on GitHub (Oct 13, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.6.3 ### Feature type Change to existing functionality ### Proposed functionality When returning global search results, order results of equal precedence and object type by value. This should ensure that otherwise equally-relevant results appear in a human-friendly order. The current ordering for cached search result objects is: ```python class CachedValue: class Meta: ordering = ('weight', 'object_type', 'object_id') ``` This FR would modify the above to: ```python class CachedValue: class Meta: ordering = ('weight', 'object_type', 'value', 'object_id') ``` (`object_id` is retained as a tie-breaker for results having the same matched value, to ensure deterministic ordering.) ### Use case This adjustment serves to ensure otherwise equally-relevant search results are listed in a human-friendly order. (This was first raised as a bug report under #13940.) ### Database changes This will require a model migration to effect the new default ordering for CachedValue. ### External dependencies None

adam added the status: accepted type: feature labels 2025-12-29 20:40:41 +01:00

adam closed this issue

2025-12-29 20:40:41 +01:00

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

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

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#8745