Elastomer Client Build Status

Making a stupid simple Elasticsearch client so your project can be smarter!

Getting Started

Get started by cloning and running a few scripts:

$ git clone https://github.com/github/elastomer-client.git
$ cd elastomer-client
$ script/bootstrap
$ script/test


The client provides a one-to-one mapping to the Elasticsearch API endpoints. The API is decomposed into logical sections and accessed according to what you are trying to accomplish. Each logical section is represented as a client class and a top-level accessor is provided for each.


API endpoints dealing with cluster level information and settings are found in the Cluster class.

require 'elastomer/client'
client = Elastomer::Client.new

# the current health summary

# detailed cluster state information

# the list of all index templates


The methods in the Index class deal with the management of indexes in the cluster. This includes setting up type mappings and adjusting settings. The actual indexing and search of documents are handled by the Docs class (discussed next).

require 'elastomer/client'
client = Elastomer::Client.new

index = client.index('twitter')
  :settings => { 'index.number_of_shards' => 3 },
  :mappings => {
    :tweet => {
      :_source => { :enabled => true },
      :_all    => { :enabled => false },
      :properties => {
        :author => { :type => 'string', :index => 'not_analyzed' },
        :tweet  => { :type => 'string', :analyze => 'standard' }


index.exists? :type => 'tweet'



The Docs class handles the indexing and searching of documents. Each instance is scoped to an index and optionally a document type.

require 'elastomer/client'
client = Elastomer::Client.new

docs = client.docs('twitter')

  :_id    => 1,
  :_type  => 'tweet',
  :author => '@pea53',
  :tweet  => 'announcing Elastomer, the stupid simple Elasticsearch client'

docs.search({:query => {:match_all => {}}}, :size => 0)


By default Elastomer uses Net::HTTP (via Faraday) to communicate with Elasticsearch. You may find that Excon performs better for your use. To enable Excon, add it to your bundle and then change your Elastomer initialization thusly:

Elastomer::Client.new(url: YOUR_ES_URL, adapter: :excon)