Elasticsearch Store: `Test Helpers Elasticsearch`
Table of contents
Interfaces
Variables
Functions
- cleanupIndex
- cleanupIndexStore
- createMappingFromDatatype
- formatUploadData
- getTestENVClientInfo
- getTotalFormat
- makeClient
- populateIndex
- upload
- waitForData
Variables
removeTypeTest
• Const
removeTypeTest: boolean
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:18
Functions
cleanupIndex
▸ cleanupIndex(client
, index
, template?
): Promise
<void
>
Parameters
Name | Type |
---|---|
client | any |
index | string |
template? | string |
Returns
Promise
<void
>
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:38
cleanupIndexStore
▸ cleanupIndexStore(store
): Promise
<void
>
Parameters
Name | Type |
---|---|
store | IndexStore <any > |
Returns
Promise
<void
>
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:165
createMappingFromDatatype
▸ createMappingFromDatatype(client
, dataType
, type?
, overrides?
): any
Parameters
Name | Type | Default value |
---|---|---|
client | Client | undefined |
dataType | DataType | undefined |
type | string | '_doc' |
overrides | Object | {} |
Returns
any
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:83
formatUploadData
▸ formatUploadData(index
, data
, apiCompatibility?
): Record
<string
, any
>[]
Parameters
Name | Type | Default value |
---|---|---|
index | string | undefined |
data | any [] | undefined |
apiCompatibility | boolean | false |
Returns
Record
<string
, any
>[]
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:138
getTestENVClientInfo
▸ getTestENVClientInfo(): TestENVClientInfo
Returns
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:214
getTotalFormat
▸ getTotalFormat(distribution
, majorVersion
, n
): number
| { relation
: string
= 'eq'; value
: number
= n }
Parameters
Name | Type |
---|---|
distribution | string |
majorVersion | number |
n | number |
Returns
number
| { relation
: string
= 'eq'; value
: number
= n }
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:253
makeClient
▸ makeClient(): Promise
<Client
>
Returns
Promise
<Client
>
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:20
populateIndex
▸ populateIndex(client
, index
, dataType
, records
, type?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
client | Client | undefined |
index | string | undefined |
dataType | DataType | undefined |
records | any [] | undefined |
type | string | '_doc' |
Returns
Promise
<void
>
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:95
upload
▸ upload(client
, queryBody
, data
): Promise
<Record
<string
, any
>>
Parameters
Name | Type |
---|---|
client | any |
queryBody | any |
data | any [] |
Returns
Promise
<Record
<string
, any
>>
Defined in
elasticsearch-store/src/test-helpers/elasticsearch.ts:70
waitForData
▸ waitForData(client
, index
, count
, timeout?
): Promise
<void
>
Parameters
Name | Type | Default value |
---|---|---|
client | any | undefined |
index | string | undefined |
count | number | undefined |
timeout | number | 5000 |
Returns
Promise
<void
>