@terascope/opensearch-client / utils/elasticsearch

utils/elasticsearch

Type Aliases

FlattenProperties

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

Defined in: opensearch-client/src/utils/elasticsearch.ts:132

This is the return type for getFlattenedNamesAndTypes

Functions

fixMappingRequest()

fixMappingRequest(client, _params, isTemplate): any

Defined in: opensearch-client/src/utils/elasticsearch.ts:72

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

---

getClientMetadata()

getClientMetadata(client): ClientMetadata

Defined in: opensearch-client/src/utils/elasticsearch.ts:24

Parameters

Parameter	Type
client	Client

Returns

ClientMetadata

---

getClientVersion()

getClientVersion(client): number

Defined in: opensearch-client/src/utils/elasticsearch.ts:12

Parameters

Parameter	Type
client	Client

Returns

number

---

getFlattenedNamesAndTypes()

getFlattenedNamesAndTypes(config): FlattenProperties

Defined in: opensearch-client/src/utils/elasticsearch.ts:138

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

---

isElasticsearch8()

isElasticsearch8(client): boolean

Defined in: opensearch-client/src/utils/elasticsearch.ts:39

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch()

isOpensearch(client): boolean

Defined in: opensearch-client/src/utils/elasticsearch.ts:46

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch1()

isOpensearch1(client): boolean

Defined in: opensearch-client/src/utils/elasticsearch.ts:51

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch2()

isOpensearch2(client): boolean

Defined in: opensearch-client/src/utils/elasticsearch.ts:58

Parameters

Parameter	Type
client	Client

Returns

boolean

---

isOpensearch3()

isOpensearch3(client): boolean

Defined in: opensearch-client/src/utils/elasticsearch.ts:64

Parameters

Parameter	Type
client	Client

Returns

boolean