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.
npm install elasticsearch
We also provide builds of the elasticsearch.js client for use in the browser. These versions of the client are currently experimental.
If you use bower to manage your dependencies, then just run:
bower install elasticsearch
Elasticsearch.js provides support for, and is regularly tested against, Elasticsearch releases 0.90.5 and greater. We also test against the latest changes in the 0.90 and master branches of the Elasticsearch repository. To tell the client which version of Elastisearch you are using, and therefore the API it should provide, set the apiVersion config param. More info
Create a client instance
var elasticsearch = require('elasticsearch');
var client = new elasticsearch.Client({
host: 'localhost:9200',
log: 'trace'
});Send a HEAD request to /?hello=elasticsearch and allow up to 1 second for it to complete.
client.ping({
// ping usually has a 100ms timeout
requestTimeout: 1000,
// undocumented params are appended to the query string
hello: "elasticsearch!"
}, function (error) {
if (error) {
console.trace('elasticsearch cluster is down!');
} else {
console.log('All is well');
}
});Skip the callback to get a promise back
client.search({
q: 'pants'
}).then(function (body) {
var hits = body.hits.hits;
}, function (error) {
console.trace(error.message);
});Find tweets that have "elasticsearch" in their body field
client.search({
index: 'twitter',
type: 'tweets',
body: {
query: {
match: {
body: 'elasticsearch'
}
}
}
}).then(function (resp) {
var hits = resp.hits.hits;
}, function (err) {
console.trace(err.message);
});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.