Skip to main content

elasticsearch-store / index-store

index-store

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 }

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

Type Parameters

Type Parameter
T

BulkRequestData<T>

BulkRequestData<T> = T | { doc: Partial<T>; } | UpsertWithScript<T> | null

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

Type Parameters

Type Parameter
T

BulkRequestMetadata

BulkRequestMetadata = { [key in BulkAction]?: { _id?: string; _index: string; _type?: string; retry_on_conflict?: number } }

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


JoinBy

JoinBy = "AND" | "OR"

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


OnBulkConflictFn()<T>

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

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

Type Parameters

Type Parameter
T

Parameters

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

Returns

BulkRequest<Partial<T>> | null


ReadHook()<T>

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

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
docT
criticalboolean

Returns

T | false


UpdateBody<T>

UpdateBody<T> = { doc: Partial<T>; } | { script: any; }

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

Type Parameters

Type Parameter
T

UpsertWithScript<T>

UpsertWithScript<T> = object

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

Type Parameters

Type Parameter
T

Properties

script

script: object

Defined in: elasticsearch-store/src/index-store.ts:967

NameTypeDefined in
lang"painless"elasticsearch-store/src/index-store.ts:969
paramsRecord<string, unknown>elasticsearch-store/src/index-store.ts:970
sourcestringelasticsearch-store/src/index-store.ts:968
upsert

upsert: Partial<T>

Defined in: elasticsearch-store/src/index-store.ts:972


WriteHook()<T>

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

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

Type Parameters

Type Parameter
T

Parameters

ParameterType
docPartial<T>
criticalboolean

Returns

T | Partial<T>