Cache post-change data on the instance after serialization #462

New Issue

MrUnknownDE · 2026-04-05T16:34:03+02:00

MrUnknownDE commented

2026-04-05 16:34:03 +02:00

Originally created by @jeremystretch on 1/26/2026

NetBox Version

v4.5.1

Python Version

3.12

Area(s) of Concern

User Interface
REST API
GraphQL API
Python ORM
Other

Details

When calling the to_objectchange() method on an instance (to create a new ObjectChange), pre-change data is sourced from the instance's _prechange_snapshot attribute (if set). Post-change data is calculated on-demand (via serialize_object()) for the ObjectChange but is not cached on the instance being serialized.

When an object event (i.e. create, update, or delete) is queued for processing during the request-response cycle, its pre- and post-change snapshots are included by calling get_snapshots(). This utility will leverage an existing pre-change snapshot if one exists, but always force a new call to serialize_object() to generate the post-change data (except for deletion events).

We can take the opportunity presented by the first call to serialize_object() to cache the resulting data on the instance, and tweak get_snapshots() to leverage the cached data if it exists. Although the serialization overhead should be negligible, this will at least avoid a second SQL query for assigned tags for object which support tagging.

*Originally created by @jeremystretch on 1/26/2026* ### NetBox Version v4.5.1 ### Python Version 3.12 ### Area(s) of Concern - [x] User Interface - [x] REST API - [ ] GraphQL API - [ ] Python ORM - [ ] Other ### Details When calling the `to_objectchange()` method on an instance (to create a new ObjectChange), pre-change data is sourced from the instance's `_prechange_snapshot` attribute (if set). Post-change data is calculated on-demand (via `serialize_object()`) for the ObjectChange but is not cached on the instance being serialized. When an object event (i.e. create, update, or delete) is queued for processing during the request-response cycle, its pre- and post-change snapshots are included by calling [`get_snapshots()`](https://github.com/netbox-community/netbox/blob/aa69e96818a92918c4e77a0fdef45edfed820dae/netbox/extras/events.py#L39). This utility will leverage an existing pre-change snapshot if one exists, but always force a new call to `serialize_object()` to generate the post-change data (except for deletion events). We can take the opportunity presented by the first call to `serialize_object()` to cache the resulting data on the instance, and tweak `get_snapshots()` to leverage the cached data if it exists. Although the serialization overhead should be negligible, this will at least avoid a second SQL query for assigned tags for object which support tagging.

MrUnknownDE closed this issue

2026-04-05 16:34:03 +02:00

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 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 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 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 type: performance type: performance 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#462