Skip to main content

elasticsearch-store / index-store

index-store

Index

Classes

ClassDescription
IndexStoreA single index elasticsearch-store with some specific requirements around the index name, and record data

Interfaces

InterfaceDescription
BulkRequest-

Type Aliases

AnyInput<T>

AnyInput<T>: { [P in keyof T]?: T[P] | any }

Type parameters

Type parameter
T

Source

elasticsearch-store/src/index-store.ts:997


BulkRequestData<T>

BulkRequestData<T>: T | object | UpsertWithScript<T> | null

Type parameters

Type parameter
T

Source

elasticsearch-store/src/index-store.ts:975


BulkRequestMetadata

BulkRequestMetadata: { [key in BulkAction]?: Object }

Source

elasticsearch-store/src/index-store.ts:977


JoinBy

JoinBy: "AND" | "OR"

Source

elasticsearch-store/src/index-store.ts:998


OnBulkConflictFn()<T>

OnBulkConflictFn<T>: (existingItem, newItem) => BulkRequest<Partial<T>> | null

Type parameters

Type parameter
T

Parameters

ParameterType
existingItemBulkRequest<Partial<T>>
newItemBulkRequest<Partial<T>>

Returns

BulkRequest<Partial<T>> | null

Source

elasticsearch-store/src/index-store.ts:985


ReadHook()<T>

ReadHook<T>: (doc, critical) => T | false

Type parameters

Type parameter
T

Parameters

ParameterType
docT
criticalboolean

Returns

T | false

Source

elasticsearch-store/src/index-store.ts:1002


UpdateBody<T>

UpdateBody<T>: object | object

Type parameters

Type parameter
T

Source

elasticsearch-store/src/index-store.ts:999


UpsertWithScript<T>

UpsertWithScript<T>: object

Type parameters

Type parameter
T

Type declaration

script

script: object

script.lang

lang: "painless"

script.params

params: Record<string, unknown>

script.source

source: string

upsert

upsert: Partial<T>

Source

elasticsearch-store/src/index-store.ts:966


WriteHook()<T>

WriteHook<T>: (doc, critical) => T | Partial<T>

Type parameters

Type parameter
T

Parameters

ParameterType
docPartial<T>
criticalboolean

Returns

T | Partial<T>

Source

elasticsearch-store/src/index-store.ts:1001