Popularity
8.5
Stable
Activity
9.3
Declining
1,888
331
584

Code Quality Rank: L3
Monthly Downloads: 2,714,544
Programming language: Ruby
License: Apache License 2.0
Tags: Search     Projects     Elastic Search    
Latest version: v8.3.0

elasticsearch-ruby alternatives and similar gems

Based on the "Elastic Search" category.
Alternatively, view elasticsearch-ruby alternatives based on common mentions on social networks and blogs.

Do you think we are missing an alternative of elasticsearch-ruby or a related project?

Add another 'Elastic Search' Gem

README

Elasticsearch

7.17 8.1 8.2 8.3 main

This repository contains the official Elasticsearch Ruby client. The elasticsearch gem is a complete Elasticsearch client which uses two separate libraries:

Documentation

Please refer to the full documentation on elastic.co for comprehensive information.

Both elastic-transport and elasticsearch-api are also documented. You can check the elastic-transport and the elasticsearch-api documentation at RubyDocs.

Installation

Install the elasticsearch gem from Rubygems:

$ gem install elasticsearch

Or add it to your project's Gemfile:

gem 'elasticsearch', 'VERSION'

Usage example

require 'elasticsearch'

client = Elasticsearch::Client.new(log: true)

# if you specify Elasticsearch host
# client = Elasticsearch::Client.new url: 'http://localhost:9200', log: true

client.transport.reload_connections!

client.cluster.health

client.search(q: 'test')

# etc.

See also the official documentation for examples of how to use the most frequently called APIs and doc/examples for some practical examples.

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. Ensure you define a dependency for a HTTP library in your own application.

Check out these other official Ruby libraries for working with Elasticsearch:

Please see their respective READMEs for information and documentation.

Compatibility

We follow Ruby’s own maintenance policy and officially support all currently maintained versions per Ruby Maintenance Branches.

Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of Elasticsearch. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.

Development

See CONTRIBUTING.

License

This software is licensed under the [Apache 2 license](./LICENSE). See [NOTICE](./NOTICE).


*Note that all licence references and agreements mentioned in the elasticsearch-ruby README section above are relevant to that project's source code only.