elasticsearch-store / index-store
index-store
Classes
| Class | Description |
|---|---|
| IndexStore | A single index elasticsearch-store with some specific requirements around the index name, and record data |
Interfaces
| Interface | Description |
|---|---|
| BulkRequest | - |
Type Aliases
AnyInput
AnyInput<
T> = { [P in keyof T]?: T[P] | any }
Defined in: index-store.ts:980
Type Parameters
| Type Parameter |
|---|
T |
BulkRequestData
BulkRequestData<
T> =T| {doc:Partial<T>; } |UpsertWithScript<T> |null
Defined in: index-store.ts:958
Type Parameters
| Type Parameter |
|---|
T |
BulkRequestMetadata
BulkRequestMetadata =
{ [key in BulkAction]?: { _id?: string; _index: string; retry_on_conflict?: number } }
Defined in: index-store.ts:960
JoinBy
JoinBy =
"AND"|"OR"
Defined in: index-store.ts:981
OnBulkConflictFn
OnBulkConflictFn<
T> = (existingItem,newItem) =>BulkRequest<Partial<T>> |null
Defined in: index-store.ts:967
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
existingItem | BulkRequest<Partial<T>> |
newItem | BulkRequest<Partial<T>> |
Returns
BulkRequest<Partial<T>> | null
ReadHook
ReadHook<
T> = (doc,critical) =>T|false
Defined in: index-store.ts:985
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
doc | T |
critical | boolean |
Returns
T | false
UpdateBody
UpdateBody<
T> = {doc:Partial<T>; } | {script:any; }
Defined in: index-store.ts:982
Type Parameters
| Type Parameter |
|---|
T |
UpsertWithScript
UpsertWithScript<
T> =object
Defined in: index-store.ts:949
Type Parameters
| Type Parameter |
|---|
T |
Properties
script
script:
object
Defined in: index-store.ts:950
| Name | Type | Defined in |
|---|---|---|
lang | "painless" | index-store.ts:952 |
params | Record<string, unknown> | index-store.ts:953 |
source | string | index-store.ts:951 |
upsert
upsert:
Partial<T>
Defined in: index-store.ts:955
WriteHook
WriteHook<
T> = (doc,critical) =>T|Partial<T>
Defined in: index-store.ts:984
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type |
|---|---|
doc | Partial<T> |
critical | boolean |
Returns
T | Partial<T>