joshvar88 / elasticsearch-ruby

Ruby integrations for Elasticsearch

Elasticsearch

This repository contains Ruby integrations for Elasticsearch:

• a client for connecting to an Elasticsearch cluster,
• a Ruby API for the Elasticsearch's REST API,
• various extensions and utilities.

For integration with Ruby models and Rails applications, see the https://github.com/elasticsearch/elasticsearch-rails project.

Compatibility

The libraries are compatible with Ruby 1.8.7 and higher.

The library is compatible with Elasticsearch 0.90 and 1.0 -- you have to install and use a matching version, though.

The 1.x versions and the master branch are compatible with Elasticsearch 1.x API.

To use the Elasticsearch 0.90 API, install the 0.4.x gem version or use the corresponding 0.4 branch.

Installation

Install the elasticsearch package from Rubygems:

gem install elasticsearch

To use an unreleased version, either add it to your Gemfile for Bundler:

gem 'elasticsearch', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git'

or install it from a source code checkout:

git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/elasticsearch
bundle install
rake install

Usage

The elasticsearch library is a wrapper for two separate libraries:

• elasticsearch-transport, which provides a low-level Ruby client for connecting to an Elasticsearch cluster
• elasticsearch-api, which provides a Ruby API for the Elasticsearch RESTful API

require 'elasticsearch'

client = Elasticsearch::Client.new log: true

client.transport.reload_connections!

client.cluster.health

client.search q: 'test'

# etc.

Both of these libraries are extensively documented. Please read the elasticsearch-transport and the elasticsearch-api documentation carefully.

Keep in mind, that for optimal performance, you should use a HTTP library which supports persistent ("keep-alive") connections, e.g. Patron or Typhoeus.

Transport

• README
• Documentation
• Test Suite

API

• README
• Documentation
• Test Suite

Extensions

• README
• Documentation
• Test Suite

Development

To work on the code, clone and bootstrap the project first:

git clone https://github.com/elasticsearch/elasticsearch-ruby.git
cd elasticsearch-ruby/
rake setup
rake bundle

This will clone the Elasticsearch repository into the project, and run bundle install in all subprojects.

To run tests, you need to start a testing cluster on port 9250, or provide a different one in the TEST_CLUSTER_PORT environment variable.

There's a Rake task to start the testing cluster:

rake test:cluster:start

You can configure the port, path to the startup script, number of nodes, and other settings with environment variables:

TEST_CLUSTER_COMMAND=./tmp/builds/elasticsearch-2.0.0-SNAPSHOT/bin/elasticsearch \
TEST_CLUSTER_PORT=9250 \
TEST_CLUSTER_NODES=2 \
TEST_CLUSTER_NAME=my_cluster \
TEST_CLUSTER_PARAMS='-Xms500m -Xmx500m -D es.index.store.type=niofs' \
TEST_CLUSTER_TIMEOUT=120 \
rake test:cluster:start

To run tests against unreleased Elasticsearch versions, you can use the rake elasticsearch:build Rake task to build Elasticsearch from the cloned source (use rake elasticsearch:update to update the repository):

rake elasticsearch:build

You can pass a branch name (tag, commit, ...) as the Rake task variable:

rake elasticsearch:build[origin/1.x]

To run all the tests in all the subprojects, use the Rake task:

time rake test:all

License

This software is licensed under the Apache 2 license, quoted below.

Copyright (c) 2013 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.