Class OpenSearchStore

constructor

• new OpenSearchStore(options: OpenSearchStoreOptions): OpenSearchStore

  Parameters

  • options: OpenSearchStoreOptions

  Returns OpenSearchStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying @opensearch-project/opensearch client for anything not wrapped here.

  Returns any

createIndex

• createIndex(index: string, body?: Record<string, unknown>): Promise<void>

  Create an index, optionally with a body (mappings/settings/aliases).

  Parameters

  • index: string
  • Optionalbody: Record<string, unknown>

  Returns Promise<void>

deleteIndex

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

  Delete an index.

  Parameters

  • index: string

  Returns Promise<void>

indexExists

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

  Whether an index exists.

  Parameters

  • index: string

  Returns Promise<boolean>

indexDocument

• indexDocument(
      index: string,
      id: string,
      body: Record<string, unknown>,
  ): Promise<Record<string, unknown>>

  Index (create or overwrite) a document under an explicit id.

  Parameters

  • index: string
  • id: string
  • body: Record<string, unknown>

  Returns Promise<Record<string, unknown>>

get

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

  Get a document's _source by ID.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • id: string

  Returns Promise<T | undefined>

search

• search<T = Record<string, unknown>>(
      index: string,
      query: Record<string, unknown>,
  ): Promise<T>

  Run a Query-DSL search and return the hits object from the response.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • query: Record<string, unknown>

  Returns Promise<T>

deleteDocument

• deleteDocument(index: string, id: string): Promise<Record<string, unknown>>

  Delete a document by ID.

  Parameters

  • index: string
  • id: string

  Returns Promise<Record<string, unknown>>

bulk

• bulk(operations: BulkOperation[]): Promise<BulkResult>

  Run a batch of operations (already in the driver's NDJSON action/source array form) in a single request. The real _bulk API rejects an empty request body outright, so short-circuit zero operations to a trivial no-op result rather than surfacing that as an error.

  Parameters

  • operations: BulkOperation[]

  Returns Promise<BulkResult>