Elasticsearch

The elasticsearch library provides a Ruby client and API for Elasticsearch.

Features overview:

• Pluggable logging and tracing
• Plugabble connection selection strategies (round-robin, random, custom)
• Pluggable transport implementation, customizable and extendable
• Pluggable serializer implementation
• Request retries and dead connections handling
• Node reloading (based on cluster state) on errors or on demand
• Consistent API support for the whole Elasticsearch API
• Extensive documentation and examples
• Emphasis on modularity and extendability of both the client and API libraries

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

Compatibility

The library is 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.0 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 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

This 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

Install the elasticsearch package and use the API directly:

require 'elasticsearch'

client = Elasticsearch::Client.new log: true

client.cluster.health

client.transport.reload_connections!

client.search q: 'test'

# etc.

Please refer to the specific library documentation for details:

• Transport: [README] [Documentation]

• API: [README] [Documentation]

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.