Enable database migrations with open branches

[jeremystretch]

Plugin Version

v0.2.0

Proposed functionality

Implement the ability to apply database migrations (e.g. from a NetBox upgrade) with one or more open branches. Currently, this is not supported as migration operations are applied only to the main schema.

Use case

This would enable users to reliably upgrade to new NetBox versions without needing to first merge any open branches.

External dependencies

No response

[jeremystretch]

Several prerequisite items of work were identified and completed in the process of implementing this feature.

• NetBox bug #19440: All data migrations needed to be adjusted to ensure they are applied using the database connection provided by the schema editor to support application to a branch; otherwise, they default to the main schema. Fixed in NetBox v4.3.1.

• NetBox bug #19444: The data model for contact group assignments needed to be adjusted to restore change logging support. (This needed to be fixed regardless to ensure branching support, but was an immediate blocker for this FR.) Fixed in NetBox v4.3.1.

• netbox-branching bug #251: SQL index names were not being preserved when replicating tables from main into the branch schema. The fix for this implements a migration to correct existing branches in addition to addressing the process for provisioning new branches. Fixed in netbox-branching v0.5.5.

As successful migration of a branch depends crucially on the fix for NetBox bug #19440, the inclusion of this feature will necessitate raising the minimum NetBox version to v4.3.1. However, it should be possible to migrate existing branches from as far back as NetBox v4.1.0 (when branching support was first introduced).