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

Implement DATABASE_ENGINE Configuration Parameter #7661

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

Originally created by @nick-bogle on GitHub (Feb 20, 2023).

Originally assigned to: @abhi1693 on GitHub.

NetBox version

v3.4.4

Feature type

New functionality

Proposed functionality

I am proposing introduction of a DATABASE_ENGINE parameter, which would allow overwriting the default database engine of 'django.contrib.gis.db.backends.postgresql' to a custom database backend.

This would be an optional configuration parameter within the configuration.py file. In the event METRICS_ENABLED was also set, I propose we give the DATABASE_ENGINE option priority. If DATABASE_ENGINE is not set, and METRICS_ENABLED is set to True, then the database engine would be set to 'django_prometheus.db.backends.postgresql'

Use case

This would allow extending the netbox datamodel with different Postgres database extensions, for example to support PostGIS to allow geospatial data models.

Database changes

No database changes.

External dependencies

No external dependencies until a database engine was overwritten, in which case that engine may potentially have external dependencies.

Originally created by @nick-bogle on GitHub (Feb 20, 2023). Originally assigned to: @abhi1693 on GitHub. ### NetBox version v3.4.4 ### Feature type New functionality ### Proposed functionality I am proposing introduction of a DATABASE_ENGINE parameter, which would allow overwriting the default database engine of 'django.contrib.gis.db.backends.postgresql' to a custom database backend. This would be an optional configuration parameter within the configuration.py file. In the event METRICS_ENABLED was also set, I propose we give the DATABASE_ENGINE option priority. If DATABASE_ENGINE is not set, and METRICS_ENABLED is set to True, then the database engine would be set to 'django_prometheus.db.backends.postgresql' ### Use case This would allow extending the netbox datamodel with different Postgres database extensions, for example to support PostGIS to allow geospatial data models. ### Database changes No database changes. ### External dependencies No external dependencies until a database engine was overwritten, in which case that engine may potentially have external dependencies.
adam added the status: acceptedtype: feature labels 2025-12-29 20:26:35 +01:00
adam closed this issue 2025-12-29 20:26:35 +01:00
adam commented 2025-12-29 20:26:37 +01:00
Author
Owner
Copy Link

@nick-bogle commented on GitHub (Feb 20, 2023):

If approved, I am happy to take ownership and complete the PR for this feature. This would allow plugins like this to be used: https://github.com/wholesailnetworks/netbox-geo

@nick-bogle commented on GitHub (Feb 20, 2023): If approved, I am happy to take ownership and complete the PR for this feature. This would allow plugins like this to be used: https://github.com/wholesailnetworks/netbox-geo
adam commented 2025-12-29 20:26:37 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 27, 2023):

Just a minor note: We probably want to add an ENGINE parameter to the existing DATABASE config (as opposed to establishing a separate setting), e.g.:

DATABASE = {
    'ENGINE': 'my.custom.backend',
    'NAME': 'netbox',
    'USER': 'netbox', 
    ...
}

To confirm, this would default to django.db.backends.postgresql (or, if METRICS_ENABLED is true, django_prometheus.db.backends.postgresql), but be overridden by any user-specified value.

I don't believe there's anything precluding this from being implemented in v3.4, so I'll assign it you @nick-bogle. Thanks!

@jeremystretch commented on GitHub (Feb 27, 2023): Just a minor note: We probably want to add an `ENGINE` parameter to the existing `DATABASE` config (as opposed to establishing a separate setting), e.g.: ``` DATABASE = { 'ENGINE': 'my.custom.backend', 'NAME': 'netbox', 'USER': 'netbox', ... } ``` To confirm, this would default to `django.db.backends.postgresql` (or, if `METRICS_ENABLED` is true, `django_prometheus.db.backends.postgresql`), but be overridden by any user-specified value. I don't believe there's anything precluding this from being implemented in v3.4, so I'll assign it you @nick-bogle. Thanks!
adam commented 2025-12-29 20:26:38 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 16, 2023):

@nick-bogle are you still planning to work on this?

@jeremystretch commented on GitHub (Mar 16, 2023): @nick-bogle are you still planning to work on this?
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#7661
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?