Class ElasticsearchStore

constructor

• new ElasticsearchStore(options: ClientOptions): ElasticsearchStore

  Parameters

  • options: ClientOptions

  Returns ElasticsearchStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): Client

  Returns the underlying @elastic/elasticsearch client for anything not wrapped here.

  Returns Client

createIndex

• createIndex(
      index: string,
      options?: ElasticsearchCreateIndexOptions,
  ): Promise<void>

  Create an index, optionally with mappings/settings/aliases.

  Parameters

  • index: string
  • options: ElasticsearchCreateIndexOptions = {}

  Returns Promise<void>

deleteIndex

• deleteIndex(index: string): Promise<void>

  Delete an index. Resolves without error if the index doesn't exist.

  Parameters

  • index: string

  Returns Promise<void>

indexExists

• indexExists(index: string): Promise<boolean>

  Whether an index exists.

  Parameters

  • index: string

  Returns Promise<boolean>

getMapping

• getMapping(index: string): Promise<MappingTypeMapping | undefined>

  Get the field mappings for an index.

  Parameters

  • index: string

  Returns Promise<MappingTypeMapping | undefined>

putMapping

• putMapping(index: string, mappings: MappingTypeMapping): Promise<void>

  Add/update field mappings on an existing index. Mapping updates are additive - existing field mappings cannot be changed, only new fields added.

  Parameters

  • index: string
  • mappings: MappingTypeMapping

  Returns Promise<void>

getSettings

• getSettings(index: string): Promise<IndicesIndexSettings | undefined>

  Get an index's settings.

  Parameters

  • index: string

  Returns Promise<IndicesIndexSettings | undefined>

putSettings

• putSettings(index: string, settings: IndicesIndexSettings): Promise<void>

  Update dynamic index settings (e.g. number_of_replicas, refresh_interval). Static settings like number_of_shards require closing the index first (not wrapped here - use getClient()).

  Parameters

  • index: string
  • settings: IndicesIndexSettings

  Returns Promise<void>

refreshIndex

• refreshIndex(index: string): Promise<void>

  Refresh an index so recently-written documents become visible to search immediately, rather than waiting for the automatic refresh interval.

  Parameters

  • index: string

  Returns Promise<void>

indexDocument

• indexDocument(
      index: string,
      document: Record<string, unknown>,
      options?: IndexDocumentOptions & { id?: string },
  ): Promise<string>

  Index (create or overwrite) a document. Omit id to let Elasticsearch auto-generate one. Returns the assigned _id.

  Parameters

  • index: string
  • document: Record<string, unknown>
  • options: IndexDocumentOptions & { id?: string } = {}

  Returns Promise<string>

getDocument

• getDocument<T = Record<string, unknown>>(
      index: string,
      id: string,
  ): Promise<T | null>

  Get a document by ID. Returns null if it doesn't exist.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • id: string

  Returns Promise<T | null>

documentExists

• documentExists(index: string, id: string): Promise<boolean>

  Whether a document exists.

  Parameters

  • index: string
  • id: string

  Returns Promise<boolean>

updateDocument

• updateDocument(
      index: string,
      id: string,
      partial: Record<string, unknown>,
      options?: UpdateDocumentOptions,
  ): Promise<void>

  Partially update a document by merging partial into the stored _source. Pass options.upsert to insert that document if id doesn't already exist yet. Throws EmptyResultError if the document doesn't exist and no upsert was provided.

  Parameters

  • index: string
  • id: string
  • partial: Record<string, unknown>
  • options: UpdateDocumentOptions = {}

  Returns Promise<void>

deleteDocument

• deleteDocument(
      index: string,
      id: string,
      options?: DeleteDocumentOptions,
  ): Promise<boolean>

  Delete a document by ID. Returns true if a document was deleted, false if it didn't exist (rather than throwing, since "already gone" is a common, non-exceptional outcome for a delete).

  Parameters

  • index: string
  • id: string
  • options: DeleteDocumentOptions = {}

  Returns Promise<boolean>

bulk

• bulk(actions: BulkAction[]): Promise<BulkResult>

  Run a batch of index/create/update/delete operations in a single request. Unlike a SQL transaction, this is not atomic - each item succeeds or fails independently; check result.errors and each item's error field rather than assuming all-or-nothing.

  Parameters

  • actions: BulkAction[]

  Returns Promise<BulkResult>

bulkIndex

• bulkIndex(
      index: string,
      documents: { id?: string; document: Record<string, unknown> }[],
  ): Promise<BulkResult>

  Convenience wrapper around bulk() for indexing many documents into one index at once.

  Parameters

  • index: string
  • documents: { id?: string; document: Record<string, unknown> }[]

  Returns Promise<BulkResult>

bulkDelete

• bulkDelete(index: string, ids: string[]): Promise<BulkResult>

  Convenience wrapper around bulk() for deleting many documents from one index at once.

  Parameters

  • index: string
  • ids: string[]

  Returns Promise<BulkResult>

search

• search<T = Record<string, unknown>>(
      index: string,
      params?: SearchParams,
  ): Promise<SearchResult<T>>

  Run a Query DSL search (match/term/bool/range/etc.) against one or more indices (comma-separated, or a wildcard pattern). Supports from/size pagination, sort, and named aggs.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • params: SearchParams = {}

  Returns Promise<SearchResult<T>>

count

• count(index: string, query?: QueryDslQueryContainer): Promise<number>

  Count documents matching a query (or all documents, if query is omitted) without fetching them.

  Parameters

  • index: string
  • Optionalquery: QueryDslQueryContainer

  Returns Promise<number>

putAlias

• putAlias(index: string, alias: string): Promise<void>

  Point an alias at an index, creating the alias if it doesn't exist.

  Parameters

  • index: string
  • alias: string

  Returns Promise<void>

deleteAlias

• deleteAlias(index: string, alias: string): Promise<void>

  Remove an alias from an index.

  Parameters

  • index: string
  • alias: string

  Returns Promise<void>

getAlias

• getAlias(alias: string): Promise<string[]>

  List the indices an alias currently points at.

  Parameters

  • alias: string

  Returns Promise<string[]>

swapAlias

• swapAlias(alias: string, fromIndex: string, toIndex: string): Promise<void>

  Atomically repoint an alias from one index to another - the standard zero-downtime reindex pattern (build the new index, then swap the alias in one request so readers never see a moment with no index behind the alias).

  Parameters

  • alias: string
  • fromIndex: string
  • toIndex: string

  Returns Promise<void>