Note: In the past months we have worked on the new Elasticsearch Node.js client, and if you want you can already try it by following the instructions below, while if you're going to use the legacy one or report an issue, please check out elastic/elasticsearch-js-legacy.
The official Node.js client for Elasticsearch.
- One-to-one mapping with REST API.
- Generalized, pluggable architecture.
- Configurable, automatic discovery of cluster nodes.
- Persistent, Keep-Alive connections.
- Load balancing (with pluggable selection strategy) across all available nodes.
- TypeScript support out of the box.
npm install @elastic/elasticsearch
The minimum supported version of Node.js is
The library is compatible with all Elasticsearch versions since 5.x, but you should use the same major version of the Elasticsearch instance that you are using.
# Elasticsearch 7.x @elastic/elasticsearch@7 # Elasticsearch 6.x @elastic/elasticsearch@6 # Elasticsearch 5.x @elastic/elasticsearch@5
Install multiple versions
If you are using multiple versions of Elasticsearch, you need to use multiple versions of the client. In the past, install multiple versions of the same package was not possible, but with
npm v6.9, you can do that via aliasing.
The command you must run to install different version of the client is:
npm install <alias>@npm:@elastic/elasticsearch@<version>
So for example if you need to install
6.x, you will run
npm install es6@npm:@elastic/elasticsearch@6npm install es7@npm:@elastic/elasticsearch@7
package.json will look like the following:
And finally, you will require the packages from your code by using the alias you have defined.
const Client: Client6 =const Client: Client7 =const client6 = node: ''const client7 = node: ''client6client7
Finally, if you want to install the client for the next version of Elasticsearch (the one that lives in Elasticsearch’s master branch), you can use the following command:
npm install esmaster@github:elastic/elasticsearch-js
You can find the full documentation in our docs website.
const Client =const client = node: ''// promise APIconst result = await client// callback APIclient
The returned value of every API call is formed as follows:
The client is designed to be easily configured as you see fit for your needs, following you can see all the possible options that you can use to configure it.
Request specific options
If needed you can pass request specific options in a second object:
// promise APIconst result = await client
The supported request specific options are:
This software is licensed under the Apache 2 license.