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. Just require 'patron' in your code, and the library will automatically use it as the Faraday adapter.

Transport

API

Extensions

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.

akito0107 / elasticsearch-ruby