elasticsearch.js

The official low-level Elasticsearch client for Node.js and the browser.

Features

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.

Install

npm install elasticsearch

Browser Builds

We also provide builds of the elasticsearch.js client for use in the browser. If your project uses Angular or jQuery we also provide specifc builds for you, simply include the elasticsearch.{{lib}}.js files in your project instead.

v1.1.0: zip, tar.gz
master: zip, tar.gz

Docs

Examples

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({
  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~~

License

This software is licensed under the Apache 2 license, quoted below.

Copyright (c) 2013 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.

diffused/elasticsearch-js