Overview

This is the official Ruby client for Elastic Enterprise Search.

Current development happens in the master branch.

The library is compatible with all Elastic Enterprise Search versions since 7.x but you have to use a matching major version:

For Elastic Enterprise Search 7.0 and later, use the major version 7 (7.x.y) of the library.

This library uses elasticsearch-transport, the low-level Ruby client for connecting to an Elasticsearch cluster - also used in the official Elasticsearch Ruby Client.

All requests, if successful, will return an Elasticsearch::Transport::Transport::Response instance. You can access the response body, headers and status.

elasticsearch-transport defines a number of exception classes for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. More details here. You can find the full documentation for elasticsearch-transport at RubyDoc.

The clients pass different options to transport, you can check them out on RubyDocs.

If you don’t specify a host and port, the client will default to http://localhost:3002. Otherwise pass in the :host parameter as a String.

You can enable logging with the default logger by passing log: true as a parameter to the client’s initializer, or pass in a Logger object with the :logger parameter:

logger = MyLogger.new
client = Elastic::EnterpriseSearch::Client.new(logger: logger)

Licensed to Elasticsearch B.V. under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. Elasticsearch B.V. licenses this file to you 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.