Skip to main content

SearchEngine

Home > @backstage/plugin-search-common > SearchEngine

Warning: This API is now obsolete.

Import from @backstage/plugin-search-backend-node instead

Interface that must be implemented by specific search engines, responsible for performing indexing and querying and translating abstract queries into concrete, search engine-specific queries.

Signature:

export interface SearchEngine 

Methods

Method

Description

getIndexer(type)

Factory method for getting a search engine indexer for a given document type.

query(query, options)

Perform a search query against the SearchEngine.

setTranslator(translator)

Override the default translator provided by the SearchEngine.