Elasticsearch Store: `Interfaces Index Config`
interfaces.IndexConfig
A versioned Index Configuration
Type parameters
Name | Type |
---|---|
T | extends AnyObject |
Table of contents
Properties
- _meta
- bulk_max_size
- bulk_max_wait
- data_schema
- data_type
- default_query_access
- default_sort
- enable_index_mutations
- event_time_field
- id_field
- index_schema
- index_settings
- ingest_time_field
- logger
- name
- namespace
- version
Properties
_meta
• Optional
_meta: Record
<string
, any
>
Any metadata to add to the index mapping
Defined in
elasticsearch-store/src/interfaces.ts:95
bulk_max_size
• Optional
bulk_max_size: number
The number of records to accumulate before sending the bulk request
Defined in
elasticsearch-store/src/interfaces.ts:58
bulk_max_wait
• Optional
bulk_max_wait: number
The maximum amount of time to wait for before send the bulk request
Defined in
elasticsearch-store/src/interfaces.ts:53
data_schema
• Optional
data_schema: DataSchema
The data schema format
Defined in
elasticsearch-store/src/interfaces.ts:48
data_type
• data_type: DataType
The DataType of the index (used for generating the mappings)
Defined in
elasticsearch-store/src/interfaces.ts:33
default_query_access
• Optional
default_query_access: QueryAccess
<T
>
The default query access to use
Defined in
elasticsearch-store/src/interfaces.ts:90
default_sort
• Optional
default_sort: string
Default sort
Defined in
elasticsearch-store/src/interfaces.ts:70
enable_index_mutations
• Optional
enable_index_mutations: boolean
Enable index mutations so indexes will be auto created or updated
Default
false
Defined in
elasticsearch-store/src/interfaces.ts:23
event_time_field
• Optional
event_time_field: keyof T
Event Time field from the source record
Defined in
elasticsearch-store/src/interfaces.ts:85
id_field
• Optional
id_field: string
| keyof T
ID field
Defined in
elasticsearch-store/src/interfaces.ts:75
index_schema
• Optional
index_schema: IndexSchema
Schema Specification for the Data and ES
Defined in
elasticsearch-store/src/interfaces.ts:43
index_settings
• Optional
index_settings: ESIndexSettings
Elasticsearch Index Settings
Defined in
elasticsearch-store/src/interfaces.ts:38
ingest_time_field
• Optional
ingest_time_field: keyof T
Ingest Time field on the source record
Defined in
elasticsearch-store/src/interfaces.ts:80
logger
• Optional
logger: Logger
Logger to use for debugging and certain internal errors
Defaults
to a debug logger
Defined in
elasticsearch-store/src/interfaces.ts:65
name
• name: string
This is the data type and base name of the index
Defined in
elasticsearch-store/src/interfaces.ts:11
namespace
• Optional
namespace: string
The namespace that will be prefixed to the name value when generating the index name or anything else that needs to be namespaced.
Defined in
elasticsearch-store/src/interfaces.ts:17
version
• Optional
version: number
Data Version, this allows multiple versions of an index to exist with the same Schema