
Security News
pnpm 10.12 Introduces Global Virtual Store and Expanded Version Catalogs
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
github.com/elasticsearch/elasticsearch-ruby
Download the latest version of Elasticsearch or sign-up for a free trial of Elastic Cloud.
This repository contains the official Elasticsearch Ruby client. The elasticsearch
gem is a complete Elasticsearch client which uses two separate libraries:
elastic-transport
- provides the low-level code for connecting to an Elasticsearch cluster.elasticsearch-api
- provides a Ruby API for the Elasticsearch RESTful API.Please refer to the full documentation on elastic.co for comprehensive information.
Both elastic-transport
and elasticsearch-api
are documented. You can check
the elastic-transport
and the elasticsearch-api
documentation at RubyDocs.
gem install elasticsearch
Refer to the Installation section of the getting started documentation.
Refer to the Connecting section of the getting started documentation.
require 'elasticsearch'
client = Elasticsearch::Client.new(host: 'https://my-elasticsearch-host.example')
client.ping
client.search(q: 'test')
Refer to 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:
elasticsearch-rails
- integration with Ruby models and Rails applications.elasticsearch-extensions
, deprecated.elasticsearch-dsl
which provides a Ruby API for the Elasticsearch Query DSL.Please see their respective READMEs for information and documentation.
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 without breaking. It does not mean that the client automatically supports new features of newer Elasticsearch versions; it is only possible after a release of a new client version. For example, a 8.12 client version won't automatically support the new features of the 8.13 version of Elasticsearch, the 8.13 client version is required for that. Elasticsearch language clients are only backwards compatible with default distributions and without guarantees made.
Gem Version | Elasticsearch Version | Supported | |
---|---|---|---|
8.x | → | 8.x | 8.x |
9.x | → | 9.x | 9.x |
main | → | main |
If you want to try Elasticsearch and Kibana locally, you can run the following command:
curl -fsSL https://elastic.co/start-local | sh
This will run Elasticsearch at http://localhost:9200 and Kibana at http://localhost:5601 using Docker.
More information is available here.
See CONTRIBUTING.
This software is licensed under the Apache 2 license. See NOTICE.
FAQs
Unknown package
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10.12.1 introduces a global virtual store for faster installs and new options for managing dependencies with version catalogs.
Security News
Amaro 1.0 lays the groundwork for stable TypeScript support in Node.js, bringing official .ts loading closer to reality.
Research
A deceptive PyPI package posing as an Instagram growth tool collects user credentials and sends them to third-party bot services.