NeoAnd/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2025-08-24 08:25:17 -06:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

7016 add search indexes

Browse Source
This commit is contained in:
Arthur 2022-09-19 13:29:41 -07:00
parent 133b342238
commit 2fad277c89
4 changed files with 251 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
netbox/circuits/search_indexes.py Normal file
View File

@ -0,0 +1,41 @@
import dcim.filtersets
import dcim.tables
from circuits.models import Circuit, Provider, ProviderNetwork
from django.db import models
from search.models import SearchMixin
class ProviderIndex(SearchMixin):
def __init__(self):
self.model = Provider
self.queryset = (Provider.objects.annotate(count_circuits=count_related(Circuit, 'provider')),)
self.filterset = circuits.filtersets.ProviderFilterSet
self.table = circuits.tables.ProviderTable
self.url = 'circuits:provider_list'
class CircuitIndex(SearchMixin):
def __init__(self):
self.model = Circuit
self.queryset = Circuit.objects.prefetch_related(
'type', 'provider', 'tenant', 'tenant__group', 'terminations__site'
)
self.filterset = circuits.filtersets.CircuitFilterSet
self.table = circuits.tables.CircuitTable
self.url = 'circuits:circuit_list'
class ProviderNetworkIndex(SearchMixin):
def __init__(self):
self.model = ProviderNetwork
self.queryset = ProviderNetwork.objects.prefetch_related('provider')
self.filterset = circuits.filtersets.ProviderNetworkFilterSet
self.table = circuits.tables.ProviderNetworkTable
self.url = 'circuits:providernetwork_list'
CIRCUIT_SEARCH_TYPES = {
'provider': ProviderIndex(),
'circuit': CircuitIndex(),
'providernetwork': ProviderNetworkIndex(),
}

212
netbox/dcim/search_indexes.py
View File

@ -19,130 +19,152 @@ from search.models import SearchMixin
class SiteIndex(SearchMixin): class SiteIndex(SearchMixin):
model = Site
queryset = Site.objects.prefetch_related('region', 'tenant', 'tenant__group') def __init__(self):
filterset = dcim.filtersets.SiteFilterSet self.model = Site
table = dcim.tables.SiteTable self.queryset = Site.objects.prefetch_related('region', 'tenant', 'tenant__group')
url = 'dcim:site_list' self.filterset = dcim.filtersets.SiteFilterSet
self.table = dcim.tables.SiteTable
self.url = 'dcim:site_list'
class RackIndex(SearchMixin): class RackIndex(SearchMixin):
model = Rack
queryset = Rack.objects.prefetch_related('site', 'location', 'tenant', 'tenant__group', 'role').annotate( def __init__(self):
device_count=count_related(Device, 'rack') self.model = Rack
) self.queryset = Rack.objects.prefetch_related('site', 'location', 'tenant', 'tenant__group', 'role').annotate(
filterset = dcim.filtersets.RackFilterSet device_count=count_related(Device, 'rack')
table = dcim.tables.RackTable )
url = 'dcim:rack_list' self.filterset = dcim.filtersets.RackFilterSet
self.table = dcim.tables.RackTable
self.url = 'dcim:rack_list'
class RackReservationIndex(SearchMixin): class RackReservationIndex(SearchMixin):
model = RackReservation
queryset = RackReservation.objects.prefetch_related('rack', 'user') def __init__(self):
filterset = dcim.filtersets.RackReservationFilterSet self.model = RackReservation
table = dcim.tables.RackReservationTable self.queryset = RackReservation.objects.prefetch_related('rack', 'user')
url = 'dcim:rackreservation_list' self.filterset = dcim.filtersets.RackReservationFilterSet
self.table = dcim.tables.RackReservationTable
self.url = 'dcim:rackreservation_list'
class LocationIndex(SearchMixin): class LocationIndex(SearchMixin):
model = Site
queryset = Location.objects.add_related_count( def __init__(self):
Location.objects.add_related_count(Location.objects.all(), Device, 'location', 'device_count', cumulative=True), self.model = Site
Rack, self.queryset = Location.objects.add_related_count(
'location', Location.objects.add_related_count(Location.objects.all(), Device, 'location', 'device_count', cumulative=True),
'rack_count', Rack,
cumulative=True, 'location',
).prefetch_related('site') 'rack_count',
filterset = dcim.filtersets.LocationFilterSet cumulative=True,
table = dcim.tables.LocationTable ).prefetch_related('site')
url = 'dcim:location_list' self.filterset = dcim.filtersets.LocationFilterSet
self.table = dcim.tables.LocationTable
self.url = 'dcim:location_list'
class DeviceTypeIndex(SearchMixin): class DeviceTypeIndex(SearchMixin):
model = DeviceType
queryset = DeviceType.objects.prefetch_related('manufacturer').annotate( def __init__(self):
instance_count=count_related(Device, 'device_type') self.model = DeviceType
) self.queryset = DeviceType.objects.prefetch_related('manufacturer').annotate(
filterset = dcim.filtersets.DeviceTypeFilterSet instance_count=count_related(Device, 'device_type')
table = dcim.tables.DeviceTypeTable )
url = 'dcim:devicetype_list' self.filterset = dcim.filtersets.DeviceTypeFilterSet
self.table = dcim.tables.DeviceTypeTable
self.url = 'dcim:devicetype_list'
class DeviceIndex(SearchMixin): class DeviceIndex(SearchMixin):
model = DeviceIndex
queryset = Device.objects.prefetch_related( def __init__(self):
'device_type__manufacturer', self.model = DeviceIndex
'device_role', self.queryset = Device.objects.prefetch_related(
'tenant', 'device_type__manufacturer',
'tenant__group', 'device_role',
'site', 'tenant',
'rack', 'tenant__group',
'primary_ip4', 'site',
'primary_ip6', 'rack',
) 'primary_ip4',
filterset = dcim.filtersets.DeviceFilterSet 'primary_ip6',
table = dcim.tables.DeviceTable )
url = 'dcim:device_list' self.filterset = dcim.filtersets.DeviceFilterSet
self.table = dcim.tables.DeviceTable
self.url = 'dcim:device_list'
class ModuleTypeIndex(SearchMixin): class ModuleTypeIndex(SearchMixin):
model = ModuleType
queryset = ModuleType.objects.prefetch_related('manufacturer').annotate( def __init__(self):
instance_count=count_related(Module, 'module_type') self.model = ModuleType
) self.queryset = ModuleType.objects.prefetch_related('manufacturer').annotate(
filterset = dcim.filtersets.ModuleTypeFilterSet instance_count=count_related(Module, 'module_type')
table = dcim.tables.ModuleTypeTable )
url = 'dcim:moduletype_list' self.filterset = dcim.filtersets.ModuleTypeFilterSet
self.table = dcim.tables.ModuleTypeTable
self.url = 'dcim:moduletype_list'
class ModuleIndex(SearchMixin): class ModuleIndex(SearchMixin):
model = Module
queryset = Module.objects.prefetch_related( def __init__(self):
'module_type__manufacturer', self.model = Module
'device', self.queryset = Module.objects.prefetch_related(
'module_bay', 'module_type__manufacturer',
) 'device',
filterset = dcim.filtersets.ModuleFilterSet 'module_bay',
table = dcim.tables.ModuleTable )
url = 'dcim:module_list' self.filterset = dcim.filtersets.ModuleFilterSet
self.table = dcim.tables.ModuleTable
self.url = 'dcim:module_list'
class VirtualChassisIndex(SearchMixin): class VirtualChassisIndex(SearchMixin):
model = VirtualChassis
queryset = VirtualChassis.objects.prefetch_related('master').annotate( def __init__(self):
member_count=count_related(Device, 'virtual_chassis') self.model = VirtualChassis
) self.queryset = VirtualChassis.objects.prefetch_related('master').annotate(
filterset = dcim.filtersets.VirtualChassisFilterSet member_count=count_related(Device, 'virtual_chassis')
table = dcim.tables.VirtualChassisTable )
url = 'dcim:virtualchassis_list' self.filterset = dcim.filtersets.VirtualChassisFilterSet
self.table = dcim.tables.VirtualChassisTable
self.url = 'dcim:virtualchassis_list'
class CableIndex(SearchMixin): class CableIndex(SearchMixin):
model = Cable
queryset = Cable.objects.all() def __init__(self):
filterset = dcim.filtersets.CableFilterSet self.model = Cable
table = dcim.tables.CableTable self.queryset = Cable.objects.all()
url = 'dcim:cable_list' self.filterset = dcim.filtersets.CableFilterSet
self.table = dcim.tables.CableTable
self.url = 'dcim:cable_list'
class PowerFeedIndex(SearchMixin): class PowerFeedIndex(SearchMixin):
model = PowerFeed
queryset = PowerFeed.objects.all() def __init__(self):
filterset = dcim.filtersets.PowerFeedFilterSet self.model = PowerFeed
table = dcim.tables.PowerFeedTable self.queryset = PowerFeed.objects.all()
url = 'dcim:powerfeed_list' self.filterset = dcim.filtersets.PowerFeedFilterSet
self.table = dcim.tables.PowerFeedTable
self.url = 'dcim:powerfeed_list'
DCIM_SEARCH_ORDERING = [ DCIM_SEARCH_TYPES = {
SiteIndex, 'site': SiteIndex(),
RackIndex, 'rack': RackIndex(),
RackReservationIndex, 'rackreservation': RackReservationIndex(),
LocationIndex, 'location': LocationIndex(),
DeviceTypeIndex, 'devicetype': DeviceTypeIndex(),
DeviceIndex, 'device': DeviceIndex(),
ModuleTypeIndex, 'moduletype': ModuleTypeIndex(),
ModuleIndex, 'module': ModuleIndex(),
VirtualChassisIndex, 'virtualchassis': VirtualChassisIndex(),
CableIndex, 'cable': CableIndex(),
PowerFeedIndex, 'powerfeed': PowerFeedIndex(),
] }

81
netbox/ipam/search_indexes.py Normal file
View File

@ -0,0 +1,81 @@
import dcim.filtersets
import dcim.tables
from dcim.models import ASN, VLAN, VRF, Aggregate, IPAddress, Prefix, Service
from django.db import models
from search.models import SearchMixin
class VRFIndex(SearchMixin):
def __init__(self):
self.model = VRF
self.queryset = VRF.objects.prefetch_related('tenant', 'tenant__group')
self.filterset = ipam.filtersets.VRFFilterSet
self.table = ipam.tables.VRFTable
self.url = 'ipam:vrf_list'
class AggregateIndex(SearchMixin):
def __init__(self):
self.model = Aggregate
self.queryset = Aggregate.objects.prefetch_related('rir')
self.filterset = ipam.filtersets.AggregateFilterSet
self.table = ipam.tables.AggregateTable
self.url = 'ipam:aggregate_list'
class PrefixIndex(SearchMixin):
def __init__(self):
self.model = Prefix
self.queryset = Prefix.objects.prefetch_related(
'site', 'vrf__tenant', 'tenant', 'tenant__group', 'vlan', 'role'
)
self.filterset = ipam.filtersets.PrefixFilterSet
self.table = ipam.tables.PrefixTable
self.url = 'ipam:prefix_list'
class IPAddressIndex(SearchMixin):
def __init__(self):
self.model = IPAddress
self.queryset = IPAddress.objects.prefetch_related('vrf__tenant', 'tenant', 'tenant__group')
self.filterset = ipam.filtersets.IPAddressFilterSet
self.table = ipam.tables.IPAddressTable
self.url = 'ipam:ipaddress_list'
class VLANIndex(SearchMixin):
def __init__(self):
self.model = VLAN
self.queryset = VLAN.objects.prefetch_related('site', 'group', 'tenant', 'tenant__group', 'role')
self.filterset = ipam.filtersets.VLANFilterSet
self.table = ipam.tables.VLANTable
self.url = 'ipam:vlan_list'
class ASNIndex(SearchMixin):
def __init__(self):
self.model = ASN
self.queryset = ASN.objects.prefetch_related('rir', 'tenant', 'tenant__group')
self.filterset = ipam.filtersets.ASNFilterSet
self.table = ipam.tables.ASNTable
self.url = 'ipam:asn_list'
class ServiceIndex(SearchMixin):
def __init__(self):
self.model = Service
self.queryset = Service.objects.prefetch_related('device', 'virtual_machine')
self.filterset = ipam.filtersets.ServiceFilterSet
self.table = ipam.tables.ServiceTable
self.url = 'ipam:service_list'
IPAM_SEARCH_TYPES = {
'vrf': VRFIndex(),
'aggregate': AggregateIndex(),
'prefix': PrefixIndex(),
'ipaddress': IPAddressIndex(),
'vlan': VLANIndex(),
'asn': ASNIndex(),
'service': ServiceIndex(),
}

31
netbox/search/models.py
View File

@ -2,19 +2,17 @@ from django.core.exceptions import ImproperlyConfigured
from django.db import models from django.db import models
class SearchMixin(models.Model): class SearchMixin(object):
""" """
Base class for building search indexes. Base class for building search indexes.
""" """
model = None def __init__(self, model=None, queryset=None, filterset=None, table=None, url=None):
queryset = None self.model = model
filterset = None self.queryset = queryset
table = None self.filterset = filterset
url = None self.table = table
self.url = url
class Meta:
abstract = True
def get_model(self): def get_model(self):
""" """
@ -26,8 +24,7 @@ class SearchMixin(models.Model):
model = self.model model = self.model
else: else:
raise ImproperlyConfigured( raise ImproperlyConfigured(
f"{self.__class__.__name__}s is missing a Model. Define " f"{self.__class__.__name__}s is missing a Model. Set model in init or override"
f"{self.__class__.__name__}s.model or override "
f"{self.__class__.__name__}s.get_model()." f"{self.__class__.__name__}s.get_model()."
) )
@ -43,8 +40,7 @@ class SearchMixin(models.Model):
queryset = self.queryset queryset = self.queryset
else: else:
raise ImproperlyConfigured( raise ImproperlyConfigured(
f"{self.__class__.__name__}s is missing a QuerySet. Define " f"{self.__class__.__name__}s is missing a QuerySet. Set queryset in init or override "
f"{self.__class__.__name__}s.queryset or override "
f"{self.__class__.__name__}s.get_queryset()." f"{self.__class__.__name__}s.get_queryset()."
) )
@ -60,8 +56,7 @@ class SearchMixin(models.Model):
filterset = self.filterset filterset = self.filterset
else: else:
raise ImproperlyConfigured( raise ImproperlyConfigured(
f"{self.__class__.__name__}s is missing a FilterSet. Define " f"{self.__class__.__name__}s is missing a FilterSet. Set filterset in init or override "
f"{self.__class__.__name__}s.filterset or override "
f"{self.__class__.__name__}s.get_filterset()." f"{self.__class__.__name__}s.get_filterset()."
) )
@ -77,8 +72,7 @@ class SearchMixin(models.Model):
table = self.table table = self.table
else: else:
raise ImproperlyConfigured( raise ImproperlyConfigured(
f"{self.__class__.__name__}s is missing a Table. Define " f"{self.__class__.__name__}s is missing a Table. Set table in init or override "
f"{self.__class__.__name__}s.table or override "
f"{self.__class__.__name__}s.get_table()." f"{self.__class__.__name__}s.get_table()."
) )
@ -94,8 +88,7 @@ class SearchMixin(models.Model):
url = self.url url = self.url
else: else:
raise ImproperlyConfigured( raise ImproperlyConfigured(
f"{self.__class__.__name__}s is missing a URL. Define " f"{self.__class__.__name__}s is missing a URL. Set url in init or override "
f"{self.__class__.__name__}s.url or override "
f"{self.__class__.__name__}s.get_url()." f"{self.__class__.__name__}s.get_url()."
) )