In the next months this client will be deprecated, so you should start migrating your codebase as soon as possible.
We have built a migration guide that will help you move to the new client quickly, and if you have questions or need help, please open an issue.
The official low-level Elasticsearch client for Node.js and the browser.
- One-to-one mapping with REST API and the other official clients
- Generalized, pluggable architecture. See Extending Core Components
- Configurable, automatic discovery of cluster nodes
- Persistent, Keep-Alive connections
- Load balancing (with pluggable selection strategy) across all available nodes.
Use in Node.js
npm install elasticsearch
Use in the Browser
Check out the Browser Builds doc page for help downloading and setting up the client for use in the browser.
- Quick Start
- Browser Builds
- Extending Core Components
You can probably find help in #kibana on freenode.
Supported Elasticsearch Versions
Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.12 and greater. We also test against the latest changes in several branches in the Elasticsearch repository. To tell the client which version of Elasticsearch you are using, and therefore the API it should provide, set the
apiVersion config param. More info
Create a client instance
var elasticsearch = ;var client =host: 'localhost:9200'log: 'trace'apiVersion: '7.2' // use the same version of your Elasticsearch instance;
Send a HEAD request to
/ and allow up to 1 second for it to complete.
Skip the callback to get a promise back
tryconst response = await client;consolecatch errorconsole
Find tweets that have "elasticsearch" in their body field
const response = await clientfor const tweet of responsehitshitsconsole;
More examples and detailed information about each method are available here
This software is licensed under the Apache 2 license, quoted below.
Copyright (c) 2014 Elasticsearch <http://www.elasticsearch.org> Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.