elasticsearch-store / utils/elasticsearch

utils/elasticsearch

Type Aliases

FlattenProperties

FlattenProperties: Record<string, [ESFieldType, string]>

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:240

This is the return type for getFlattenedNamesAndTypes

Variables

__timeSeriesTest

const __timeSeriesTest: object = {}

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:27

Type declaration

date?

optional date: Date

Functions

filterBulkRetries()

filterBulkRetries<T>(records, result): T[]

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:50

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
records	T[]
result	BulkResponse

Returns

T[]

---

fixMappingRequest()

fixMappingRequest(client, _params, isTemplate): any

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:180

Parameters

Parameter	Type
client	Client
_params	{ body: ESMapping; index: string; name: string; }
_params.body	ESMapping
_params.index?	string
_params.name?	string
isTemplate	boolean

Returns

any

---

getBulkResponseItem()

getBulkResponseItem(input): BulkResponseItemResult

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:112

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

Parameter	Type
input	any

Returns

BulkResponseItemResult

---

getClientMetadata()

getClientMetadata(client): ClientMetadata

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:131

Parameters

Parameter	Type
client	Client

Returns

ClientMetadata

---

getESVersion()

getESVersion(client): number

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:119

Parameters

Parameter	Type
client	Client

Returns

number

---

getFlattenedNamesAndTypes()

getFlattenedNamesAndTypes(config): FlattenProperties

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:246

This is useful for diffing the property mappings, the keys should be sorted so this can be stringified and diffed.

Parameters

Parameter	Type
config	ESTypeMapping

Returns

FlattenProperties

---

getTimeByField()

getTimeByField(field): (input) => number

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:13

Parameters

Parameter	Type	Default value
field	string	''

Returns

Function

Parameters

Parameter	Type
input	any

Returns

number

---

isElasticsearch6()

isElasticsearch6(client): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:146

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isElasticsearch8()

isElasticsearch8(client): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:153

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch()

isOpensearch(client): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:160

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch1()

isOpensearch1(client): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:165

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch2()

isOpensearch2(client): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:172

Parameters

Parameter	Type
client	Client

Returns

boolean

---

shardsPath()

shardsPath(index): (stats) => Shard[]

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:17

Parameters

Parameter	Type
index	string

Returns

Function

Parameters

Parameter	Type
stats	any

Returns

Shard[]

---

timeSeriesIndex()

timeSeriesIndex(index, timeSeriesFormat): string

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:34

Parameters

Parameter	Type	Default value
index	string	undefined
timeSeriesFormat	TimeSeriesFormat	'monthly'

Returns

string

---

verifyIndexShards()

verifyIndexShards(shards): boolean

Defined in: elasticsearch-store/src/utils/elasticsearch.ts:21

Parameters

Parameter	Type
shards	Shard[]

Returns

boolean