Data migrations do not use connection provided by the schema editor #11146

New Issue

adam · 2025-12-29T21:40:57+01:00

adam commented

2025-12-29 21:40:57 +01:00

Originally created by @jeremystretch on GitHub (May 8, 2025).

Originally assigned to: @jeremystretch on GitHub.

Deployment Type

Self-hosted

NetBox Version

v4.3.0

Python Version

3.10

Steps to Reproduce

This issue affects certain schema migrations within NetBox which manipulate data within the database. Some of the affected migrations are:

dcim/0206_load_module_type_profiles
ipam/0080_populate_service_parents
tenancy/0018_contact_group

The migrations may not function correctly if applied to a non-default database (i.e. manage.py migrate --database foo). This hasn't surfaced as an issue to date, but presents a concern now that support for external databases has been added in NetBox v4.3.0 under #18780.

Expected Behavior

ORM queries made within the context of a migration should always explicitly reference the connection provided by the schema editor. For example:

def migrate_contact_groups(apps, schema_editor):
    Contact = apps.get_model('tenancy', 'Contact')
    Contact.objects.using(schema_editor.connection.alias).update(...)

Observed Behavior

These queries are being executed without specifying a connection, which results in utilizing the default database.

def migrate_contact_groups(apps, schema_editor):
    Contact = apps.get_model('tenancy', 'Contact')
    Contact.objects.update(...)

Originally created by @jeremystretch on GitHub (May 8, 2025). Originally assigned to: @jeremystretch on GitHub. ### Deployment Type Self-hosted ### NetBox Version v4.3.0 ### Python Version 3.10 ### Steps to Reproduce This issue affects certain schema migrations within NetBox which manipulate data within the database. Some of the affected migrations are: - `dcim/0206_load_module_type_profiles` - `ipam/0080_populate_service_parents` - `tenancy/0018_contact_group` The migrations may not function correctly if applied to a non-default database (i.e. `manage.py migrate --database foo`). This hasn't surfaced as an issue to date, but presents a concern now that support for external databases has been added in NetBox v4.3.0 under #18780. ### Expected Behavior ORM queries made within the context of a migration should always explicitly reference the connection provided by the schema editor. For example: ```python def migrate_contact_groups(apps, schema_editor): Contact = apps.get_model('tenancy', 'Contact') Contact.objects.using(schema_editor.connection.alias).update(...) ``` ### Observed Behavior These queries are being executed without specifying a connection, which results in utilizing the default database. ```python def migrate_contact_groups(apps, schema_editor): Contact = apps.get_model('tenancy', 'Contact') Contact.objects.update(...) ```

adam added the type: bug status: accepted severity: medium labels 2025-12-29 21:40:57 +01:00

adam closed this issue

2025-12-29 21:40:57 +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#11146