@terascope/opensearch-client / test-helpers/elasticsearch

test-helpers/elasticsearch

Interfaces

Interface	Description
TestENVClientInfo	-

Variables

removeTypeTest

const removeTypeTest: boolean

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:18

Functions

cleanupIndex()

cleanupIndex(client, index, template?): Promise<void>

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

Parameters

Parameter	Type
client	any
index	string
template?	string

Returns

Promise<void>

---

createMappingFromDatatype()

createMappingFromDatatype(client, dataType, type, overrides): any

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:103

Parameters

Parameter	Type	Default value
client	Client	undefined
dataType	DataType	undefined
type	string	'_doc'
overrides	{ }	{}

Returns

any

---

formatUploadData()

formatUploadData(index, data, apiCompatibility): Record<string, any>[]

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:170

Formats data for use with the upload function.

Set apiCompatibility to true for usage within elasticsearch-api & elasticsearch-assets

[( { action: { index: meta }, data } )],

and false for raw elasticsearch bulk queries

[{ index: meta }, record )]

Parameters

Parameter	Type	Default value
index	string	undefined
data	any[]	undefined
apiCompatibility	boolean	false

Returns

Record<string, any>[]

---

getTestENVClientInfo()

getTestENVClientInfo(): TestENVClientInfo

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:241

Returns

TestENVClientInfo

---

getTotalFormat()

getTotalFormat(distribution, majorVersion, n): number | { relation: string; value: number; }

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:279

Parameters

Parameter	Type
distribution	string
majorVersion	number
n	number

Returns

number | { relation: string; value: number; }

---

makeClient()

makeClient(rootCaPath?): Promise<Client>

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:20

Parameters

Parameter	Type
rootCaPath?	string

Returns

Promise<Client>

---

populateIndex()

populateIndex(client, index, dataType, records, type): Promise<void>

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:115

Parameters

Parameter	Type	Default value
client	Client	undefined
index	string	undefined
dataType	DataType	undefined
records	any[]	undefined
type	string	'_doc'

Returns

Promise<void>

---

upload()

upload(client, queryBody, data): Promise<Record<string, any>>

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:90

This is a quick & easy way to upload data, however, types are auto generated by elasticsearch itself. If you need to control types for detailed searching mechanisms use populateIndex. ( uses the bulk method under the hood )

Parameters

Parameter	Type
client	any
queryBody	any
data	any[]

Returns

Promise<Record<string, any>>

---

waitForData()

waitForData(client, index, count, timeout): Promise<void>

Defined in: opensearch-client/src/test-helpers/elasticsearch.ts:198

wait for an index to have a count of records in it

Parameters

Parameter	Type	Default value
client	any	undefined
index	string	undefined
count	number	undefined
timeout	number	5000

Returns

Promise<void>