Elasticsearch Store: `interfaces`
Table of contents
Interfaces
- BulkResponse
- BulkResponseItem
- DataSchema
- IndexConfig
- IndexModelOptions
- IndexModelRecord
- IndexSchema
- MigrateIndexOptions
Type Aliases
- AsyncFn
- BulkAction
- BulkResponseItems
- CreateRecordInput
- FindOneOptions
- FindOptions
- IndexModelConfig
- MigrateIndexStoreOptions
- SanitizeFields
- SearchResult
- Shard
- TimeSeriesFormat
- UpdateRecordInput
Type Aliases
AsyncFn
Ƭ AsyncFn<T
>: () => Promise
<T
>
Type parameters
Name |
---|
T |
Type declaration
▸ (): Promise
<T
>
Returns
Promise
<T
>
Defined in
elasticsearch-store/src/interfaces.ts:166
BulkAction
Ƭ BulkAction: "index"
| "create"
| "delete"
| "update"
Defined in
elasticsearch-store/src/interfaces.ts:168
BulkResponseItems
Ƭ BulkResponseItems: { [key in BulkAction]?: BulkResponseItem }
Defined in
elasticsearch-store/src/interfaces.ts:182
CreateRecordInput
Ƭ CreateRecordInput<T
>: Omit
<T
, keyof IndexModelRecord
> & { client_id
: number
}
Type parameters
Name | Type |
---|---|
T | extends IndexModelRecord |
Defined in
elasticsearch-store/src/interfaces.ts:219
FindOneOptions
Ƭ FindOneOptions<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
excludes? | keyof T [] |
includes? | keyof T [] |
variables? | xLuceneVariables |
Defined in
elasticsearch-store/src/interfaces.ts:295
FindOptions
Ƭ FindOptions<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
excludes? | keyof T [] |
from? | number |
includes? | keyof T [] |
size? | number |
sort? | string |
variables? | xLuceneVariables |
Defined in
elasticsearch-store/src/interfaces.ts:286
IndexModelConfig
Ƭ IndexModelConfig<T
>: Omit
<IndexConfig
<T
>, "namespace"
| "id_field"
| "index_schema"
| "data_schema"
| "default_query_access"
| "enable_index_mutations"
> & { sanitize_fields?
: SanitizeFields
; schema
: any
; strict_mode?
: boolean
; timeseries?
: boolean
; unique_fields?
: keyof T
[] ; version
: number
}
Type parameters
Name | Type |
---|---|
T | extends IndexModelRecord |
Defined in
elasticsearch-store/src/interfaces.ts:229
MigrateIndexStoreOptions
Ƭ MigrateIndexStoreOptions: Omit
<MigrateIndexOptions
, "config"
>
Defined in
elasticsearch-store/src/interfaces.ts:309
SanitizeFields
Ƭ SanitizeFields: Object
Index signature
▪ [field: string
]: "trimAndToLower"
| "trim"
| "toSafeString"
Defined in
elasticsearch-store/src/interfaces.ts:254
SearchResult
Ƭ SearchResult<T
>: Object
Type parameters
Name |
---|
T |
Type declaration
Name | Type |
---|---|
_fetched | number |
_total | number |
results | T [] |
Defined in
elasticsearch-store/src/interfaces.ts:311
Shard
Ƭ Shard: Object
Type declaration
Name | Type |
---|---|
primary | boolean |
stage | string |
Defined in
elasticsearch-store/src/interfaces.ts:190
TimeSeriesFormat
Ƭ TimeSeriesFormat: "daily"
| "monthly"
| "yearly"
Defined in
elasticsearch-store/src/interfaces.ts:127
UpdateRecordInput
Ƭ UpdateRecordInput<T
>: Partial
<Omit
<T
, keyof IndexModelRecord
>> & { client_id?
: number
}
Type parameters
Name | Type |
---|---|
T | extends IndexModelRecord |