Have ideas to improve npm?Join in the discussion! ¬Ľ

    elasticsearch
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/elasticsearch package

    16.7.2¬†‚Äʬ†Public¬†‚Äʬ†Published

    elasticsearch.js 16.7.2


    We have released the new JavaScript client!

    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.

    Coverage Status Dependencies up to date

    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.

    Use in Node.js

    npm install elasticsearch
    

    NPM Stats

    Use in the Browser

    Check out the Browser Builds doc page for help downloading and setting up the client for use in the browser.

    Docs

    Questions?

    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

    Examples

    Create a client instance

    var elasticsearch = require('elasticsearch');
    var client = new elasticsearch.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.

    client.ping({
      // ping usually has a 3000ms timeout
      requestTimeout: 1000
    }, function (error) {
      if (error) {
        console.trace('elasticsearch cluster is down!');
      } else {
        console.log('All is well');
      }
    });

    Skip the callback to get a promise back

    try {
      const response = await client.search({
        q: 'pants'
      });
      console.log(response.hits.hits)
    } catch (error) {
      console.trace(error.message)
    }

    Find tweets that have "elasticsearch" in their body field

    const response = await client.search({
      index: 'twitter',
      type: 'tweets',
      body: {
        query: {
          match: {
            body: 'elasticsearch'
          }
        }
      }
    })
     
    for (const tweet of response.hits.hits) {
      console.log('tweet:', tweet);
    }

    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) 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.
    

    Install

    npm i elasticsearch

    DownloadsWeekly Downloads

    301,331

    Version

    16.7.2

    License

    Apache-2.0

    Unpacked Size

    3.23 MB

    Total Files

    59

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar