This repository contains Ruby integrations for Elasticsearch:
- a client for connecting to an Elasticsearch cluster,
- a Ruby API for the Elasticsearch's REST API,
- a Ruby API for the X-Pack APIs,
- various extensions and utilities.
For integration with Ruby models and Rails applications, see the elasticsearch-rails project.
The Elasticsearch client is compatible with Ruby 1.9 and higher. Other libraries in this repository might require a more recent Ruby version.
The client's API is compatible with Elasticsearch's API versions from 0.90 till current, just use a release matching major version of Elasticsearch.
| Ruby | Elasticsearch | |
|---|---|---|
| 0.90 | → | 0.90 |
| 1.x | → | 1.x |
| 2.x | → | 2.x |
| 5.x | → | 5.x |
| 6.x | → | 6.x |
| master | → | master |
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
The elasticsearch
library is a wrapper for two separate libraries:
elasticsearch-transport, which provides a low-level Ruby client for connecting to an Elasticsearch clusterelasticsearch-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. These libraries are not dependencies of the elasticsearch gems, so be sure to define a dependency in your own application.
This repository contains these additional Ruby libraries:
elasticsearch-extensions, which provides a set of extensions to the base library,elasticsearch-dsl, which provides a Ruby API for the Elasticsearch Query DSL,elasticsearch-xpack, which provides Ruby API for the X-Pack APIs.
Please see their respective READMEs for information and documentation.
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):
Note: If you have gems from the elasticsearch family installed system-wide,
and want to use development ones, prepend the command with bundle exec.
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
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.