pelias-esclient

1.0.0 • Public • Published

Installation

$ npm install pelias-esclient

NPM

Note: you will need node and npm installed first.

The easiest way to install node.js is with nave.sh by executing [sudo] ./nave.sh usemain stable

Configuration

see: https://github.com/pelias/config

Full configuration reference: http://www.elasticsearch.org/guide/en/elasticsearch/client/javascript-api/current/configuration.html

Usage

This library provides an elasticsearch client which is configured for bulk imports.

The API is exactly the same as https://github.com/elasticsearch/elasticsearch-js with the addition of a buffered streaming import named client.stream.

var esclient = require('pelias-esclient')();
 
var command = {
  _index: 'pelias', _type: 'myindex', _id: 'myrecordid',
  data: {
    my: 'properties'
  }
}
 
esclient.stream.write( command );
var esclient = require('pelias-esclient')();
 
some_other_stream.pipe( esclient.stream );

Contributing

Please fork and pull request against upstream master on a feature branch.

Pretty please; provide unit tests and script fixtures in the test directory.

Running Unit Tests

$ npm test

Continuous Integration

Travis tests every release against node version 0.10

Build Status

Package Sidebar

Install

npm i pelias-esclient

Weekly Downloads

25

Version

1.0.0

License

MIT

Last publish

Collaborators

  • missinglink
  • dianashk
  • julian_mapzen
  • pelias
  • trescube