pelias-deprecated / esclient

(DEPRECATED) Pelias elasticsearch bulk indexer.

Installation

$ npm install pelias-esclient

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

esclient's Issues

Remove dependency of pelias-config

I would suggest that using pelias-config is counter intuitive to the end user. I expected that the config I pass esclient is passed directly to the elasticsearch client. Here is what I would propose:

module.exports = function( config ){

  // Create new esclient with settings
  var client = new elasticsearch.Client( config || {} );

and then a someone who wants to use pelias-config, would just do the following:

  var settings = require('pelias-config').generate();
  var esclient = require('pelias-esclient')(settings);

This seems a much cleaner separation to how I would expect as a consumer of esclient.