# elasticsearchclient

> A client for Elastic Search

Latest version **0.5.3** (published 2013-07-08) · 0 weekly downloads

## Install

```sh
npm install elasticsearchclient
pnpm add elasticsearchclient
yarn add elasticsearchclient
bun add elasticsearchclient
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.3 |
| Published | 2013-07-08 |
| First published | 2012-03-11 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 0.3.0 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Phillip Rosen |
| Maintainers | phill.rosen |
| Keywords | elasticsearch, elastic, search, client |

## Links

- npm: https://www.npmjs.com/package/elasticsearchclient
- Repository: https://github.com/phillro/node-elasticsearch-client
- npm.io page: https://npm.io/package/elasticsearchclient

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.5.3 (latest) — 2013-07-08
- 0.5.2 — 2013-07-08
- 0.4.0 — 2013-03-03
- 0.3.0 — 2013-02-06
- 0.2.3 — 2013-01-23
- 0.2.2 — 2012-08-02
- 0.2.1 — 2012-06-14
- 0.1.8 — 2012-03-13
- 0.2.0 — 2012-03-11

## README

[![build status](https://secure.travis-ci.org/phillro/node-elasticsearch-client.png)](http://travis-ci.org/phillro/node-elasticsearch-client)
Elastic Search Client
=====================

A node.js client for elasticsearch (http://www.elasticsearch.com). 

## Installation

```
npm install elasticsearchclient
```

## Executing commands on elasticsearch

```javascript
ElasticSearchClient = require('elasticsearchclient');

var serverOptions = {
    host: 'localhost',
    port: 9200,
    pathPrefix:'optional pathPrefix',
    secure: true||false,
    //Optional basic HTTP Auth
    auth: {
   	username: process.env.ES_USERNAME,
    	password: process.env.ES_PASSWORD
  }
};



```


OR specify multiple hosts

```javascript
var serverOptions = {
    hosts:[
        {
            host: 'localhost',
            port: 9200
        }]
};
```

```javascript
var elasticSearchClient = new ElasticSearchClient(serverOptions);

var qryObj = {
    field : term
}

elasticSearchClient.search('my_index_name', 'my_type_name', qryObj)
    .on('data', function(data) {
        console.log(JSON.parse(data))
    })
    .on('done', function(){
        //always returns 0 right now
    })
    .on('error', function(error){
        console.log(error)
    })
    .exec()

//Canonical search
 elasticSearchClient.search('my_index_name', 'my_type_name', qryObj, function(err, data){
    console.log(JSON.parse(data))
 })

//Search call as a reusable object with a canonical callback
mySearchCall = elasticSearchClient.search('my_index_name', 'my_type_name', qryObj);
//Do it once
mySearchCall.exec(function(err, data){
    console.log(JSON.parse(data))
})
//Do it twice
mySearchCall.exec(function(err, data){
    console.log(JSON.parse(data))
})



elasticSearchClient.index(indexName, typeName, document, id, options)
    .on('data', function(data) {
        console.log(data)
    })
    .exec()

//Bulk index example
var commands = []
commands.push({ "index" : { "_index" :'my_index_name', "_type" : "my_type_name"} })
commands.push({field1:'value',field2:'value'})


    elasticSearchClient.bulk(commands, {})
            .on('data', function(data) {})
            .on('done', function(done){})
            .on('error', function(error){})
            .exec();

```

Twitter stream:
Seems to be a problem in the es with deleting streams. May require a node restart for modifications/deletes to take effect


```javascript
elasticSearchClient.createOrModifyTwitterRiver(riverName, riverData)
    .on('data', function (data) {
        console.log(data)
        assert.ok(JSON.parse(data).ok)
    })
    .on('error',
    function (error) {
        console.log(error)
        assert.ok(false)
    }).exec()
```
## Code coverage

Run code coverage by executing:

	$npm run-script coverage

*Requires [visionmedia/jscoverage](https://github.com/visionmedia/node-jscoverage)

## What can i do?

Most of the API (http://www.elasticsearch.org/guide/reference/api/) is implemented. 

## License

Copyright (c) 2011 Phillip Rosen

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

---
_Source: https://npm.io/package/elasticsearchclient · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._