Class: Esearch::Type

Inherits:

Object

• Object
• Esearch::Type

Includes:

Adamantium::Flat, Mixin::Document, Mixin::Exist, Mixin::Search

Defined in:

lib/esearch/type.rb

Overview

Interface to a specific elasticsearch type

Instance Method Summary

• #connection ⇒ Faraday::Connection private

  Return connection.

• #document(id) ⇒ Document private

  Return document handler.

• #path ⇒ Pathname private

  Return path.

Methods included from Mixin::Exist

#exist?

Methods included from Mixin::Document

#index, #index_create, #index_update

Methods included from Mixin::Search

#search

Instance Method Details

#connection ⇒ Faraday::Connection

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return connection

Returns:

• (Faraday::Connection)

# File 'lib/esearch/type.rb', line 25

def connection
  es_index.connection
end

#document(id) ⇒ Document

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return document handler

Parameters:

• id (String)

Returns:

• (Document)

# File 'lib/esearch/type.rb', line 15

def document(id)
  Document.new(self, id)
end

#path ⇒ Pathname

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return path

Returns:

• (Pathname)

# File 'lib/esearch/type.rb', line 35

def path
  es_index.path.join(name)
end