Elasticsearch Store: `index-store`
Table of contents
Classes
Interfaces
Type Aliases
- AnyInput
- BulkRequestData
- BulkRequestMetadata
- JoinBy
- OnBulkConflictFn
- ReadHook
- UpdateBody
- UpsertWithScript
- WriteHook
Type Aliases
AnyInput
Ƭ AnyInput<T
>: { [P in keyof T]?: T[P] | any }
Type parameters
Name |
---|
T |
Defined in
elasticsearch-store/src/index-store.ts:983
BulkRequestData
Ƭ BulkRequestData<T
>: T
| { doc
: Partial
<T
> } | UpsertWithScript
<T
> | null
Type parameters
Name |
---|
T |
Defined in
elasticsearch-store/src/index-store.ts:961
BulkRequestMetadata
Ƭ BulkRequestMetadata: { [key in BulkAction]?: Object }
Defined in
elasticsearch-store/src/index-store.ts:963
JoinBy
Ƭ JoinBy: "AND"
| "OR"
Defined in
elasticsearch-store/src/index-store.ts:984
OnBulkConflictFn
Ƭ OnBulkConflictFn<T
>: (existingItem
: BulkRequest
<Partial
<T
>>, newItem
: BulkRequest
<Partial
<T
>>) => BulkRequest
<Partial
<T
>> | null
Type parameters
Name |
---|
T |
Type declaration
▸ (existingItem
, newItem
): BulkRequest
<Partial
<T
>> | null
Parameters
Name | Type |
---|---|
existingItem | BulkRequest <Partial <T >> |
newItem | BulkRequest <Partial <T >> |
Returns
BulkRequest
<Partial
<T
>> | null
Defined in
elasticsearch-store/src/index-store.ts:971
ReadHook
Ƭ ReadHook<T
>: (doc
: T
, critical
: boolean
) => T
| false
Type parameters
Name |
---|
T |
Type declaration
▸ (doc
, critical
): T
| false
Parameters
Name | Type |
---|---|
doc | T |
critical | boolean |
Returns
T
| false
Defined in
elasticsearch-store/src/index-store.ts:988
UpdateBody
Ƭ UpdateBody<T
>: { doc
: Partial
<T
> } | { script
: any
}
Type parameters
Name |
---|
T |
Defined in
elasticsearch-store/src/index-store.ts:985
UpsertWithScript
Ƭ UpsertWithScript<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
script | { lang : "painless" ; params : Record <string , unknown > ; source : string } |
script.lang | "painless" |
script.params | Record <string , unknown > |
script.source | string |
upsert | Partial <T > |
Defined in
elasticsearch-store/src/index-store.ts:952
WriteHook
Ƭ WriteHook<T
>: (doc
: Partial
<T
>, critical
: boolean
) => T
| Partial
<T
>
Type parameters
Name |
---|
T |
Type declaration
▸ (doc
, critical
): T
| Partial
<T
>
Parameters
Name | Type |
---|---|
doc | Partial <T > |
critical | boolean |
Returns
T
| Partial
<T
>