NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 07:12:16 -06:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Initial work on #13182

Browse Source
This commit is contained in:
Jeremy Stretch
2025-12-03 16:40:35 -05:00
parent 502b33b144
commit dfbc795299
4 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/plugins/development/models.md
View File

@@ -67,6 +67,24 @@ class MyModel(ExportTemplatesMixin, TagsMixin, models.Model):
...
```
## Additional Models
In addition to the base NetBoxModel class, the following additional classes are provided for convenience.
!!! info "These base classes were added to the plugins API in NetBox v4.5."
### PrimaryModel
PrimaryModel is the go-to class for most object types. It extends NetBoxModel with `description` and `comments` fields, and it introduces support for ownership assignment.
### OrganizationalModel
OrganizationalModel is used by object types whose function is primarily the organization of other objects. It adds to NetBoxModel fields for `name`, `slug`, and `description`. It also supports ownership assignment.
### NestedGroupModel
NestedGroupModel is used for objects which arrange into a recursive hierarchy (like regions and locations) via its self-referential `parent` foreign key. It adds to NetBoxModel fields for `name`, `slug`, `description`, and `comments`. It also supports ownership assignment.
## Database Migrations
Once you have completed defining the model(s) for your plugin, you'll need to create the database schema migrations. A migration file is essentially a set of instructions for manipulating the PostgreSQL database to support your new model, or to alter existing models. Creating migrations can usually be done automatically using Django's `makemigrations` management command. (Ensure that your plugin has been installed and enabled first, otherwise it won't be found.)