Skip to main content
Version: Next

ElasticSearchClientWrapper

Home > @backstage/plugin-search-backend-module-elasticsearch > ElasticSearchClientWrapper

A wrapper class that exposes logical methods that are conditionally fired against either a configured Elasticsearch client or a configured Opensearch client.

This is necessary because, despite its intention to be API-compatible, the opensearch client does not support API key-based authentication. This is also the sanest way to accomplish this while making typescript happy.

In the future, if the differences between implementations become unmaintainably divergent, we should split out the Opensearch and Elasticsearch search engine implementations.

Signature:

class ElasticSearchClientWrapper 

Methods

Method

Modifiers

Description

bulk(bulkOptions)

createIndex(options)

deleteIndex(options)

fromClientOptions(options)

static

getAliases(options)

indexExists(options)

listIndices(options)

putIndexTemplate(template)

search(options)

updateAliases(options)