Search
Note
This feature was introduced in NetBox v3.4.
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).
# 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:
indexes = [MyModelIndex]
Tip
The path to the list of search indexes can be modified by setting search_indexes
in the PluginConfig instance.
SearchIndex
Base class for building search indexes.
Attributes:
Name | Type | Description |
---|---|---|
model |
The model class for which this index is used. |
|
category |
The label of the group under which this indexer is categorized (for form field display). If none, the name of the model's app will be used. |
|
fields |
An iterable of two-tuples defining the model fields to be indexed and the weight associated with each. |
get_field_type(instance, field_name)
staticmethod
Return the data type of the specified model field.
get_field_value(instance, field_name)
staticmethod
Return the value of the specified model field as a string.
to_cache(instance, custom_fields=None)
classmethod
Return a list of ObjectFieldValue representing the instance fields to be cached.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
instance |
The instance being cached. |
required | |
custom_fields |
An iterable of CustomFields to include when caching the instance. If None, all custom fields defined for the model will be included. (This can also be provided during bulk caching to avoid looking up the available custom fields for each instance.) |
None |