Class: JayAPI::Elasticsearch::Async

Inherits:

Object

• Object
• JayAPI::Elasticsearch::Async

Extended by:

Forwardable

Defined in:

lib/jay_api/elasticsearch/async.rb

Overview

Provides functionality to perform asynchronous operations on an elasticsearch index. For more information: ruby-concurrency.github.io/concurrent-ruby/1.3.4/Concurrent

Instance Attribute Summary

• #index ⇒ Object readonly

  Returns the value of attribute index.

Instance Method Summary

• #delete_by_query(query, slices: 5) ⇒ Concurrent::Promise

  Deletes asynchronously the documents matching the given query from the Index.

• #initialize(index) ⇒ Async constructor

  A new instance of Async.

Constructor Details

#initialize(index) ⇒ Async

# File 'lib/jay_api/elasticsearch/async.rb', line 24

def initialize(index)
  @index = index
end

Instance Attribute Details

#index ⇒ Object (readonly)

Returns the value of attribute index.

# File 'lib/jay_api/elasticsearch/async.rb', line 18

def index
  @index
end

Instance Method Details

#delete_by_query(query, slices: 5) ⇒ Concurrent::Promise

Deletes asynchronously the documents matching the given query from the Index.

Raises:

• (Errors::QueryExecutionError) —

  If executing the query results in errors

• (Errors::QueryExecutionFailure) —

  If executing the query results in failures

See Also:

• for more info

# File 'lib/jay_api/elasticsearch/async.rb', line 41

def delete_by_query(query, slices: 5)
  Concurrent::Promise.execute do
    async_response = index.delete_by_query(query, slices: slices, wait_for_completion: false)
    result = tasks.by_id(async_response[:task])
    validate_result(result)
    result
  end
end