Files
peeringdb-peeringdb/docs/dev/modules/search_indexes.py.md
Stefan Pratter 5eb925e319 Support 202301 (#1329)
* fix next redirect when using U2F 2FA auth (#1191)

* Added self identifier to API

* fix migrations hierarchy after merging in previous support branch

* campus object

Co-authored-by: Stefan Pratter <stefan@20c.com>

* fix out of bound error message
add city / country to campus view

* fix tests

* relock poetry

* linting

* linting

* fix docs regen

* regen docs

* linting

* refactor self entity view to support carrier and campus object types and also make it easier to support additional object types in the future

* remove debug message

---------

Co-authored-by: Gajanan Patil <dipaksavaliya.python@gmail.com>
2023-02-15 07:55:01 +00:00

4.1 KiB

Generated from search_indexes.py on 2023-02-14 15:33:37.135106

peeringdb_server.search_indexes

Defines django-haystack search indexes.

Classes


CampusIndex

CampusIndex(peeringdb_server.search_indexes.MainEntity, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


EntityIndex

EntityIndex(haystack.indexes.SearchIndex)

Search index for org, net, ix and fac entities.

Methods

build_queryset

def build_queryset(self, using=None, start_date=None, end_date=None)

Get the default QuerySet to index when doing an index update.

Subclasses can override this method to take into account related model modification times.

The default is to use SearchIndex.index_queryset and filter based on SearchIndex.get_updated_field


get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


get_updated_field

def get_updated_field(self)

Use this field to determine object age. This is required for the --age parameter to function in the update_index command.


prepare

def prepare(self, obj)

Fetches and adds/alters data before indexing.


FacilityIndex

FacilityIndex(peeringdb_server.search_indexes.MainEntity, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


IXLanPrefixIndex

IXLanPrefixIndex(peeringdb_server.search_indexes.EntityIndex, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


InternetExchangeIndex

InternetExchangeIndex(peeringdb_server.search_indexes.MainEntity, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


MainEntity

MainEntity(peeringdb_server.search_indexes.EntityIndex)

Search index for org, net, ix and fac entities.

Methods

prepare

def prepare(self, obj)

Fetches and adds/alters data before indexing.


NetworkIXLanIndex

NetworkIXLanIndex(peeringdb_server.search_indexes.EntityIndex, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


NetworkIndex

NetworkIndex(peeringdb_server.search_indexes.MainEntity, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.


OrganizationIndex

OrganizationIndex(peeringdb_server.search_indexes.MainEntity, haystack.constants.Indexable)

Search index for org, net, ix and fac entities.

Methods

get_model

def get_model(self)

Should return the Model class (not an instance) that the rest of the SearchIndex should use.

This method is required & you must override it to return the correct class.