elasticsearch-store / elasticsearch-client/client / Client
Class: Client
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:4
Constructors
new Client()
new Client(
client,distributionMeta):Client
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:8
Parameters
| Parameter | Type |
|---|---|
client | any |
distributionMeta | ClientMetadata |
Returns
Accessors
__meta
Get Signature
get __meta():
ClientMetadata
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:16
Returns
ClientMetadata
cat
Get Signature
get cat():
object
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:137
Returns
object
indices()
Parameters
| Parameter | Type |
|---|---|
params | CatIndicesParams |
Returns
Promise<CatIndicesResponse>
cluster
Get Signature
get cluster():
object
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:103
Returns
object
getSettings()
Parameters
| Parameter | Type |
|---|---|
params | ClusterGetSettingsParams |
Returns
Promise<ClusterGetSettingsResponse>
health()
Parameters
| Parameter | Type |
|---|---|
params | ClusterHealthParams |
Returns
Promise<ClusterHealthResponse>
indices
Get Signature
get indices():
object
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:362
Returns
object
create()
Creates a new index.
Parameters
| Parameter | Type |
|---|---|
params | IndicesCreateParams |
Returns
Promise<IndicesCreateResponse>
IndicesCreateResponse
delete()
Deletes one or more indices.
Parameters
| Parameter | Type |
|---|---|
params | IndicesDeleteParams |
Returns
Promise<IndicesDeleteResponse>
deleteTemplate()
Deletes index templates
Parameters
| Parameter | Type |
|---|---|
params | IndicesDeleteTemplateParams |
Returns
Promise<IndicesDeleteTemplateResponse>
IndicesDeleteTemplateResponse
exists()
Checks if a data stream, index, or alias exists.
Parameters
| Parameter | Type |
|---|---|
params | IndicesExistsParams |
Returns
Promise<boolean>
boolean
existsTemplate()
Returns true if template exists
Parameters
| Parameter | Type |
|---|---|
params | IndicesExistsTemplateParams |
Returns
Promise<boolean>
boolean
get()
Returns information about one or more indices
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetParams |
Returns
Promise<IndicesGetResponse>
getFieldMapping()
Retrieves mapping definitions for one or more fields.
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetFieldMappingParams |
Returns
Promise<IndicesGetFieldMappingResponse>
Response
IndicesGetFieldMappingResponse
getIndexTemplate()
Returns index template
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetIndexTemplateParams |
Returns
Promise<IndicesGetIndexTemplateResponse>
IndicesGetIndexTemplateResponse not supported by elasticsearch version 6 same params as IndicesGetTemplateParams
getMapping()
Retrieves mapping definitions for one or more indices
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetMappingParams |
Returns
Promise<IndicesGetMappingResponse>
IndicesGetMappingResponse
getSettings()
Returns setting information for one or more indices
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetSettingsParams |
Returns
Promise<IndicesGetSettingsResponse>
IndicesGetSettingsResponse
getTemplate()
Returns template
Parameters
| Parameter | Type |
|---|---|
params | IndicesGetTemplateParams |
Returns
Promise<IndicesGetTemplateResponse>
template
putMapping()
Adds new fields to an existing index or edit the search settings of existing fields.
Parameters
| Parameter | Type |
|---|---|
params | IndicesPutMappingParams |
Returns
Promise<IndicesPutMappingResponse>
IndicesPutMappingResponse
putSettings()
Changes a dynamic index setting in real time.
Parameters
| Parameter | Type |
|---|---|
params | IndicesPutSettingsParams |
Returns
Promise<IndicesPutSettingsResponse>
IndicesPutSettingsResponse
putTemplate()
Uploads index mapping template
Parameters
| Parameter | Type |
|---|---|
params | IndicesPutTemplateParams |
Returns
Promise<IndicesPutTemplateResponse>
IndicesPutTemplateResponse
recovery()
Returns information about shard recoveries for one or more indices
Parameters
| Parameter | Type |
|---|---|
params | IndicesRecoveryParams |
Returns
Promise<IndicesRecoveryResponse>
IndicesRecoveryResponse can be an empty query
refresh()
Makes a recent operation performed on one or more indices available for search.
Parameters
| Parameter | Type |
|---|---|
params | IndicesRefreshParams |
Returns
Promise<IndicesRefreshResponse>
IndicesRefreshResponse can be an empty query
stats()
Returns statistics for one or more indices
Parameters
| Parameter | Type |
|---|---|
params | IndicesStats |
Returns
Promise<IndicesStatsResponse>
IndicesStatsResponse
validateQuery()
Validates a query without executing it.
Parameters
| Parameter | Type |
|---|---|
params | IndicesValidateQueryParams |
Returns
Promise<IndicesValidateQueryResponse>
IndicesValidateQueryResponse
nodes
Get Signature
get nodes():
object
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:160
Returns
object
info()
Parameters
| Parameter | Type |
|---|---|
params | NodesInfoParams |
Returns
Promise<NodesInfoResponse>
stats()
Parameters
| Parameter | Type |
|---|---|
params | NodesStatsParams |
Returns
Promise<NodesStatsResponse>
tasks
Get Signature
get tasks():
object
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:688
Returns
object
cancel()
Cancels a currently running task
Parameters
| Parameter | Type |
|---|---|
params | TasksCancelParams |
Returns
Promise<TasksCancelResponse>
TasksCancelResponse
get()
Gets information about a running task
Parameters
| Parameter | Type |
|---|---|
params | TasksGetParams |
Returns
Promise<TasksGetResponse>
TasksGetResponse
list()
Returns information about the tasks currently executing in the cluster.
Parameters
| Parameter | Type |
|---|---|
params | TasksListParams |
Returns
Promise<TasksListResponse>
TasksListResponse
Methods
bulk()
bulk(
params):Promise<BulkResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:20
Parameters
| Parameter | Type |
|---|---|
params | BulkParams |
Returns
Promise<BulkResponse>
count()
count(
params):Promise<CountResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:90
Gets the number of matches for a search query or if no query provided the count for docs in an index
Parameters
| Parameter | Type |
|---|---|
params | CountParams |
Returns
Promise<CountResponse>
create()
create(
params):Promise<CreateResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:37
creates a new record, can throw if record already exists
Parameters
| Parameter | Type |
|---|---|
params | CreateParams |
Returns
Promise<CreateResponse>
delete()
delete(
params):Promise<DeleteResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:199
Deletes a specific record, requires an index and id.
Parameters
| Parameter | Type |
|---|---|
params | DeleteParams |
Returns
Promise<DeleteResponse>
deleteByQuery()
deleteByQuery(
params):Promise<DeleteByQueryResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:217
Deletes documents that match the specified query.
Parameters
| Parameter | Type |
|---|---|
params | DeleteByQueryParams |
Returns
Promise<DeleteByQueryResponse>
count or Elasticsearch task_id
exists()
exists(
params):Promise<boolean>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:235
Check that the document id exists in the specified index.
Parameters
| Parameter | Type |
|---|---|
params | ExistsParams |
Returns
Promise<boolean>
boolean
get()
get<
T>(params):Promise<GetResponse<T>>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:253
Retrieves the specified JSON document from an index or an empty doc if no doc id is found
Type Parameters
| Type Parameter | Default type |
|---|---|
T | Record<string, unknown> |
Parameters
| Parameter | Type |
|---|---|
params | GetParams |
Returns
Promise<GetResponse<T>>
Object
index()
index(
params):Promise<IndexResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:54
indexes a new record
Parameters
| Parameter | Type |
|---|---|
params | IndexParams |
Returns
Promise<IndexResponse>
info()
info():
Promise<InfoResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:270
Returns info about the cluster the client is connected to
Returns
Promise<InfoResponse>
object with cluster info
mget()
mget(
params):Promise<MGetResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:331
The multi get execution of multiple-get searches from a single API request
Parameters
| Parameter | Type |
|---|---|
params | MGetParams |
Returns
Promise<MGetResponse>
msearch()
msearch(
params):Promise<MSearchResponse<Record<string,unknown>>>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:313
The multi search execution of several searches within the same API request
Parameters
| Parameter | Type |
|---|---|
params | MSearchParams |
Returns
Promise<MSearchResponse<Record<string, unknown>>>
ping()
ping():
Promise<boolean>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:282
Returns true or false based on whether the cluster is running.
Returns
Promise<boolean>
Boolean
reindex()
reindex(
params):Promise<ReindexResponse>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:349
Re-Index data to a new index
Parameters
| Parameter | Type |
|---|---|
params | ReindexParams |
Returns
Promise<ReindexResponse>
Report of re-indexing task or task id if wait_for_completion is false
search()
search<
T>(params):Promise<SearchResponse<T>>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:295
Returns search hits that match the query defined in the request.
Type Parameters
| Type Parameter | Default type |
|---|---|
T | Record<string, unknown> |
Parameters
| Parameter | Type |
|---|---|
params | SearchParams |
Returns
Promise<SearchResponse<T>>
update()
update(
params):Promise<UpdateResponse<unknown>>
Defined in: elasticsearch-store/src/elasticsearch-client/client.ts:71
updates a record, or can upsert a record
Parameters
| Parameter | Type |
|---|---|
params | UpdateParams |
Returns
Promise<UpdateResponse<unknown>>