resourceful-elasticsearch

Elasticsearch engine module for Resourceful ODM

npm install resourceful-elasticsearch
19 downloads in the last week
74 downloads in the last month

resourceful-elasticsearch Build Status

A pluggable engine for Flatiron's Resourceful ODM layer that exposes Elasticsearch via the node-elastical module.

Exposes new methods to Resourceful such as search() and terms() as well as implementing as many of the existing ones as possible.

Examples

You can use Lucene query syntax to fetch resources:

    Creature.search("legs:4",function( err, creatures ){
        // creatures contains an array of matching records
    });

You can power autocomplete UI by looking up term frequencies:

    Creature.terms("description",function( err, term ){
        // creatures contains an array of matching records
    });

Installation

    npm install resourceful-elasticsearch

Tests

All tests are written with vows and should be run with npm:

  $ npm test

Status

So far this is mainly used by the Couchelastic hybrid engine so just contains search and configuration methods, rather than acting as a full data store. I am working on making this a functioning stand-alone engine but that's not my focus right now.

Pull requests welcome, please include tests.

Author: Richard Marr

License: Apache 2.0

npm loves you