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

Establish a concrete relationship from JobResult to related objects #7802

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

Originally created by @jeremystretch on GitHub (Mar 27, 2023).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v3.4.6

Feature type

Data model extension

Proposed functionality

The JobResult model current has a ForeignKey field to ContentType, which enables associating an instance with a particular type of NetBox model. It also has a name field to indicate the object's name, however this is not a concrete relationship in the database. This is due to the limitation of scripts and reports not being tracked as database objects.

This FR proposes the additional of an object ID field to complement the object type field, which will enable GenericForeignKey assignments for JobResults. This is possible thanks to the implementation of #11890, which introduces "real" database models representing reports and scripts.

The following changes are proposed for the JobResult model:

  1. Rename obj_type to object_type for consistency with other NetBox models using GFK.
  2. Add an object_id integer field.
  3. Add a GenericForeignKey field leveraging both of the above. Object types will be limited to those models inheriting from JobResultsMixin.

We'll keep the name field as an optional field: It can be used to differentiate among jobs pertaining to the same object. For example, we can expect a ScriptModule containing multiple scripts to have separate jobs for each script.

Use case

Introducing a database relationship between a job and its assigned object enables more robust and efficient correlation and management of jobs. For example, we'll be able to pull all jobs pertaining to a specific script via it's module:

ScriptModule.jobs.filter(name='myscript1')

Database changes

No response

External dependencies

No response

Originally created by @jeremystretch on GitHub (Mar 27, 2023). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v3.4.6 ### Feature type Data model extension ### Proposed functionality The JobResult model current has a ForeignKey field to ContentType, which enables associating an instance with a particular type of NetBox model. It also has a `name` field to indicate the object's name, however this is not a concrete relationship in the database. This is due to the limitation of scripts and reports not being tracked as database objects. This FR proposes the additional of an object ID field to complement the object type field, which will enable GenericForeignKey assignments for JobResults. This is possible thanks to the implementation of #11890, which introduces "real" database models representing reports and scripts. The following changes are proposed for the JobResult model: 1. Rename `obj_type` to `object_type` for consistency with other NetBox models using GFK. 2. Add an `object_id` integer field. 3. Add a GenericForeignKey field leveraging both of the above. Object types will be limited to those models inheriting from `JobResultsMixin`. We'll keep the `name` field as an optional field: It can be used to differentiate among jobs pertaining to the same object. For example, we can expect a ScriptModule containing multiple scripts to have separate jobs for each script. ### Use case Introducing a database relationship between a job and its assigned object enables more robust and efficient correlation and management of jobs. For example, we'll be able to pull all jobs pertaining to a specific script via it's module: ``` ScriptModule.jobs.filter(name='myscript1') ``` ### Database changes _No response_ ### External dependencies _No response_
adam added the status: acceptedtype: feature labels 2025-12-29 20:28:22 +01:00
adam closed this issue 2025-12-29 20:28:23 +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: feature
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#7802
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?