Elasticsearch Store: `Utils Elasticsearch`
Table of contents
Type Aliases
Variables
Functions
- filterBulkRetries
- fixMappingRequest
- getBulkResponseItem
- getClientMetadata
- getESVersion
- getFlattenedNamesAndTypes
- getTimeByField
- isElasticsearch6
- isElasticsearch8
- isOpensearch
- isOpensearch1
- isOpensearch2
- shardsPath
- timeSeriesIndex
- verifyIndexShards
Type Aliases
FlattenProperties
Ƭ FlattenProperties: Record
<string
, [type: ESFieldType, extra?: string]>
This is the return type for getFlattenedNamesAndTypes
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:219
Variables
__timeSeriesTest
• Const
__timeSeriesTest: Object
= {}
Type declaration
Name | Type |
---|---|
date? | Date |
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:23
Functions
filterBulkRetries
▸ filterBulkRetries<T
>(records
, result
): T
[]
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
records | T [] |
result | BulkResponse |
Returns
T
[]
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:46
fixMappingRequest
▸ fixMappingRequest(client
, _params
, isTemplate
): any
Parameters
Name | Type |
---|---|
client | Client |
_params | Record <string , any > |
isTemplate | boolean |
Returns
any
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:176
getBulkResponseItem
▸ getBulkResponseItem(input?
): BulkResponseItemResult
Get the first key and value from the bulk response:
Here is an example input:
{
"index": {
"_index": "test",
"_type": "type1",
"_id": "1",
"_version": 1,
"result": "created",
"_shards": {
"total": 2,
"successful": 1,
"failed": 0
},
"created": true,
"status": 201
}
}
Parameters
Name | Type |
---|---|
input | any |
Returns
BulkResponseItemResult
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:108
getClientMetadata
▸ getClientMetadata(client
): ClientMetadata
Parameters
Name | Type |
---|---|
client | Client |
Returns
ClientMetadata
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:127
getESVersion
▸ getESVersion(client
): number
Parameters
Name | Type |
---|---|
client | Client |
Returns
number
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:115
getFlattenedNamesAndTypes
▸ getFlattenedNamesAndTypes(config
): FlattenProperties
This is useful for diffing the property mappings, the keys should be sorted so this can be stringified and diffed.
Parameters
Name | Type |
---|---|
config | ESTypeMapping |
Returns
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:225
getTimeByField
▸ getTimeByField(field?
): (input
: any
) => number
Parameters
Name | Type | Default value |
---|---|---|
field | string | '' |
Returns
fn
▸ (input
): number
Parameters
Name | Type |
---|---|
input | any |
Returns
number
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:9
isElasticsearch6
▸ isElasticsearch6(client
): boolean
Parameters
Name | Type |
---|---|
client | Client |
Returns
boolean
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:142
isElasticsearch8
▸ isElasticsearch8(client
): boolean
Parameters
Name | Type |
---|---|
client | Client |
Returns
boolean
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:149
isOpensearch
▸ isOpensearch(client
): boolean
Parameters
Name | Type |
---|---|
client | Client |
Returns
boolean
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:156
isOpensearch1
▸ isOpensearch1(client
): boolean
Parameters
Name | Type |
---|---|
client | Client |
Returns
boolean
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:161
isOpensearch2
▸ isOpensearch2(client
): boolean
Parameters
Name | Type |
---|---|
client | Client |
Returns
boolean
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:168
shardsPath
▸ shardsPath(index
): (stats
: any
) => Shard
[]
Parameters
Name | Type |
---|---|
index | string |
Returns
fn
▸ (stats
): Shard
[]
Parameters
Name | Type |
---|---|
stats | any |
Returns
Shard
[]
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:13
timeSeriesIndex
▸ timeSeriesIndex(index
, timeSeriesFormat?
): string
Parameters
Name | Type | Default value |
---|---|---|
index | string | undefined |
timeSeriesFormat | TimeSeriesFormat | 'monthly' |
Returns
string
Defined in
elasticsearch-store/src/utils/elasticsearch.ts:30
verifyIndexShards
▸ verifyIndexShards(shards
): boolean
Parameters
Name | Type |
---|---|
shards | Shard [] |
Returns
boolean