mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
29 lines
782 B
Markdown
29 lines
782 B
Markdown
# Search
|
|
|
|
Plugins can define and register their own models to extend NetBox's core search functionality. Typically, a plugin will include a file named `search.py`, which holds all search indexes for its models (see the example below).
|
|
|
|
```python
|
|
# search.py
|
|
from netbox.search import SearchIndex
|
|
from .models import MyModel
|
|
|
|
class MyModelIndex(SearchIndex):
|
|
model = MyModel
|
|
fields = (
|
|
('name', 100),
|
|
('description', 500),
|
|
('comments', 5000),
|
|
)
|
|
```
|
|
|
|
To register one or more indexes with NetBox, define a list named `indexes` at the end of this file:
|
|
|
|
```python
|
|
indexes = [MyModelIndex]
|
|
```
|
|
|
|
!!! tip
|
|
The path to the list of search indexes can be modified by setting `search_indexes` in the PluginConfig instance.
|
|
|
|
::: netbox.search.SearchIndex
|