›

Overview

The elasticsearch Rubygem provides a low-level client for communicating with an Elasticsearch cluster, fully compatible with other official clients.

More documentation is hosted in Github and RubyDoc.

Refer to the Getting started page for a step-by-step quick start with the Ruby client.

Features

edit

Pluggable logging and tracing
Pluggable 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
Modular API implementation
100% REST API coverage

Transport and API

edit

The elasticsearch gem combines two separate Rubygems:

elastic-transport - provides an HTTP Ruby client for connecting to the Elasticsearch cluster. Refer to the documentation: Transport
elasticsearch-api - provides a Ruby API for the Elasticsearch RESTful API.

Please consult their respective documentation for configuration options and technical details.

Notably, the documentation and comprehensive examples for all the API methods are contained in the source, and available online at Rubydoc.

Keep in mind, that for optimal performance, you should use an HTTP library which supports persistent ("keep-alive") HTTP connections.

Getting started »