Repository files navigation

The official Node.js client for Elasticsearch.

If you want to try Elasticsearch and Kibana locally, you can run the following command:

curl -fsSL https://elastic.co/start-local| sh

This will run Elasticsearch athttp://localhost:9200 and Kibana athttp://localhost:5601.

More information is availablehere.

Alternatively, you candownload the latest version of Elasticsearch manually, orsign-up for a free trial of Elastic Cloud.

Refer to theInstallation sectionof the getting started documentation.

Refer to theConnecting sectionof the getting started documentation.

The Elasticsearch client is compatible with currently maintained JS versions.

Language clients are forward compatible; meaning that clients supportcommunicating with greater or equal minor versions of Elasticsearch withoutbreaking. It does not mean that the client automatically supports new featuresof newer Elasticsearch versions; it is only possible after a release of a newclient version. For example, a 8.12 client version won't automatically supportthe new features of the 8.13 version of Elasticsearch, the 8.13 client versionis required for that. Elasticsearch language clients are only backwardscompatible with default distributions and without guarantees made.

• Creating an index
• Indexing a document
• Getting documents
• Searching documents
• Updating documents
• Deleting documents
• Deleting an index

NOTE: The minimum supported version of Node.js isv20.

The client versioning follows the Elastic Stack versioning, this means thatmajor, minor, and patch releases are done following a precise schedule thatoften does not coincide with theNode.js release times.

To avoid support insecure and unsupported versions of Node.js, theclientwill drop the support of EOL versions of Node.js between minor releases.Typically, as soon as a Node.js version goes into EOL, the client will continueto support that version for at least another minor release. If you are using the clientwith a version of Node.js that will be unsupported soon, you will see a warningin your logs (the client will start logging the warning with two minors in advance).

Unless you arealways using a supported version of Node.js,we recommend defining the client dependency in yourpackage.json with the~ instead of^. In this way, you will lock thedependency on the minor release and not the major. (for example,~7.10.0 insteadof^7.10.0).

• Introduction
• Usage
• Client configuration
• API reference
• Authentication
• Observability
• Creating a child client
• Client helpers
• Typescript support
• Testing
• Examples

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 withnpm 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 install7.x and6.x, you will run:

npm install es6@npm:@elastic/elasticsearch@6npm install es7@npm:@elastic/elasticsearch@7

And yourpackage.json will look like the following:

"dependencies": {"es6":"npm:@elastic/elasticsearch@^6.7.0","es7":"npm:@elastic/elasticsearch@^7.0.0"}

You will require the packages from your code by using the alias you have defined.

const{Client:Client6}=require('es6')const{Client:Client7}=require('es7')constclient6=newClient6({cloud:{id:'<cloud-id>'},auth:{apiKey:'base64EncodedKey'}})constclient7=newClient7({cloud:{id:'<cloud-id>'},auth:{apiKey:'base64EncodedKey'}})client6.info().then(console.log,console.log)client7.info().then(console.log,console.log)

Finally, if you want to install the client for the next version of Elasticsearch(the one that lives in Elasticsearch’s main branch), you can use the followingcommand:

npm install esmain@github:elastic/elasticsearch-js

This software is licensed under theApache License 2.0.