class ElastomerClient::Client::Bulk

The Bulk class provides some abstractions and helper methods for working with the Elasticsearch bulk API command. Instances of the Bulk class accumulate indexing and delete operations and then issue a single bulk API request to Elasticsearch. Those operations are then executed by the cluster.

A maximum request size can be set. As soon as the size of the request body hits this threshold, a bulk request will be made to the search cluster. This happens as operations are added.

Additionally, a maximum action count can be set. As soon as the number of actions equals the action count, a bulk request will be made.

You can also use the ‘call` method explicitly to send a bulk request immediately.

Constants

DEFAULT_REQUEST_SIZE
SPECIAL_KEYS
UNPREFIXED_SPECIAL_KEYS

Attributes

action_count[R]
client[R]
request_size[R]

Public Class Methods

new(client, params = {}) click to toggle source

Create a new bulk client for handling some of the details of accumulating documents to index and then formatting them properly for the bulk API command.

client - ElastomerClient::Client used for HTTP requests to the server params - Parameters Hash to pass to the Client#bulk method

:request_size - the maximum request size in bytes
:action_count - the maximum number of actions
# File lib/elastomer_client/client/bulk.rb, line 186
def initialize(client, params = {})
  @client  = client
  @params  = params

  @actions = []
  @current_request_size = 0
  @current_action_count = 0
  self.request_size = params.delete(:request_size) || DEFAULT_REQUEST_SIZE
  self.action_count = params.delete(:action_count)
end

Public Instance Methods

action_count=(value) click to toggle source

Set the action count. If the value is nil, then action count limiting will not be used and a request will only be made when the call method is called. It is up to the user to ensure that the request does not exceed Elasticsearch request size limits.

If the value is a number greater than zero, then actions will be buffered until the action count is met. When this happens a bulk request is issued, queued actions are cleared, and the response from Elasticsearch is returned.

# File lib/elastomer_client/client/bulk.rb, line 228
def action_count=(value)
  if value.nil?
    @action_count = nil
  else
    @action_count = value.to_i <= 0 ? nil : value.to_i
  end
end
add_to_actions(action, document = nil) click to toggle source

Internal: Add the given ‘action` to the list of actions that will be performed by this bulk request. An optional `document` can also be given.

If the total size of the accumulated actions meets our desired request size, then a bulk API call will be performed. After the call the actions list is cleared and we’ll start accumulating actions again.

action - The bulk action (as a Hash) to perform document - Optional document for the action as a Hash or JSON encoded String

Returns the response from the bulk call if one was made or nil. Raises RequestSizeError if the given action is larger than the

configured requst size or the client.max_request_size
# File lib/elastomer_client/client/bulk.rb, line 400
def add_to_actions(action, document = nil)
  action = MultiJson.dump(action)
  size = action.bytesize

  if document
    document = MultiJson.dump(document) unless document.is_a?(String)
    size += document.bytesize
  end

  check_action_size!(size)

  response = nil
  begin
    response = call if ready_to_send?(size)
  # rubocop:disable Lint/UselessRescue
  rescue StandardError => err
    raise err
  ensure
    @actions << action
    @actions << document unless document.nil?
    @current_request_size += size
    @current_action_count += 1
  end

  response
end
call() click to toggle source

Immediately execute a bulk API call with the currently accumulated actions. The accumulated actions list will be cleared after the call has been made.

If the accumulated actions list is empty then no action is taken.

Returns the response body Hash.

# File lib/elastomer_client/client/bulk.rb, line 314
def call
  return nil if @actions.empty?

  body = @actions.join("\n") + "\n"
  client.bulk(body, @params)
ensure
  @current_request_size = 0
  @current_action_count = 0
  @actions.clear
end
check_action_size!(size) click to toggle source

Internal: Raises a RequestSizeError if the given size is larger than the configured client.max_request_size

# File lib/elastomer_client/client/bulk.rb, line 443
def check_action_size!(size)
  return unless size > client.max_request_size
  raise RequestSizeError, "Bulk action of size `#{size}` exceeds the maximum requst size: #{client.max_request_size}"
end
convert_special_keys(params) click to toggle source

Internal: Convert incoming Ruby symbol keys to their special underscore versions. Maintains API compaibility with the ‘Docs` API for `index`, `create`, `update` and `delete`.

:id -> :_id ‘id’ -> ‘_id’

params - Hash.

Returns a new params Hash with the special keys replaced.

# File lib/elastomer_client/client/bulk.rb, line 354
def convert_special_keys(params)
  new_params = params.dup

  SPECIAL_KEYS.each do |key|
    omit_prefix = (
      client.version_support.es_version_8_plus? &&
      UNPREFIXED_SPECIAL_KEYS.include?(key)
    )

    prefixed_key = "_" + key
    converted_key = (omit_prefix ? "" : "_") + key

    if new_params.key?(prefixed_key)
      new_params[converted_key] = new_params.delete(prefixed_key)
    end

    if new_params.key?(prefixed_key.to_sym)
      new_params[converted_key.to_sym] = new_params.delete(prefixed_key.to_sym)
    end

    if new_params.key?(key)
      new_params[converted_key] = new_params.delete(key)
    end

    if new_params.key?(key.to_sym)
      new_params[converted_key.to_sym] = new_params.delete(key.to_sym)
    end
  end

  new_params
end
create(document, params) click to toggle source

Add a create action to the list of bulk actions to be performed when the bulk API call is made. Parameters can be provided in the parameters hash (underscore prefix optional) or in the document hash (underscore prefix required).

document - The document to create as a Hash or JSON encoded String params - Parameters for the create action (as a Hash) (optional)

Examples

create({"foo" => "bar"}, {:_id => 1}
create({"foo" => "bar"}, {:id => 1}
create("foo" => "bar", "_id" => 1)

Returns the response from the bulk call if one was made or nil.

# File lib/elastomer_client/client/bulk.rb, line 269
def create(document, params)
  params = prepare_params(document, params)
  add_to_actions({create: params}, document)
end
delete(params) click to toggle source

Add a delete action to the list of bulk actions to be performed when the bulk API call is made.

params - Parameters for the delete action (as a Hash)

Examples

delete(:_id => 1, :_type => 'foo')

Returns the response from the bulk call if one was made or nil.

# File lib/elastomer_client/client/bulk.rb, line 302
def delete(params)
  params = prepare_params(nil, params)
  add_to_actions({delete: params})
end
index(document, params = {}) click to toggle source

Add an index action to the list of bulk actions to be performed when the bulk API call is made. Parameters can be provided in the parameters hash (underscore prefix optional) or in the document hash (underscore prefix required).

document - The document to index as a Hash or JSON encoded String params - Parameters for the index action (as a Hash) (optional)

Examples

index({"foo" => "bar"}, {:_id => 1, :_type => "foo"}
index({"foo" => "bar"}, {:id => 1, :type => "foo"}
index("foo" => "bar", "_id" => 1, "_type" => "foo")

Returns the response from the bulk call if one was made or nil.

# File lib/elastomer_client/client/bulk.rb, line 250
def index(document, params = {})
  params = prepare_params(document, params)
  add_to_actions({index: params}, document)
end
prepare_params(document, params) click to toggle source

Internal: convert special key parameters to their wire representation and apply any override document parameters.

# File lib/elastomer_client/client/bulk.rb, line 330
def prepare_params(document, params)
  params = convert_special_keys(params)

  params.delete(:_id) if params[:_id].nil? || params[:_id].to_s.empty?
  params.delete("_id") if params["_id"].nil? || params["_id"].to_s.empty?

  if client.version_support.es_version_8_plus?
    params.delete(:_type)
    params.delete("_type")
  end

  params
end
ready_to_send?(size) click to toggle source

Internal: Determines if adding ‘size` more bytes and one more action will bring the current bulk request over the `request_size` limit or the `action_count` limit. If this method returns true, then it is time to dispatch the bulk request.

Returns ‘true` of `false`

# File lib/elastomer_client/client/bulk.rb, line 433
def ready_to_send?(size)
  total_request_size = @current_request_size + size
  total_action_count = @current_action_count + 1

  (request_size && total_request_size >= request_size) ||
  (action_count && total_action_count >  action_count)
end
request_size=(value) click to toggle source

Set the request size in bytes. If the value is nil, then request size limiting will not be used and a request will only be made when the call method is called. It is up to the user to ensure that the request does not exceed Elasticsearch request size limits.

If the value is a number greater than zero, then actions will be buffered until the request size is met or exceeded. When this happens a bulk request is issued, queued actions are cleared, and the response from Elasticsearch is returned.

# File lib/elastomer_client/client/bulk.rb, line 208
def request_size=(value)
  if value.nil?
    @request_size = nil
  else
    value = value.to_i
    value = nil if value <= 0
    value = client.max_request_size if value > client.max_request_size
    @request_size = value
  end
end
update(document, params) click to toggle source

Add an update action to the list of bulk actions to be performed when the bulk API call is made. Parameters can be provided in the parameters hash (underscore prefix optional) or in the document hash (underscore prefix required).

document - The document to update as a Hash or JSON encoded String params - Parameters for the update action (as a Hash) (optional)

Examples

update({"doc" => {"foo" => "bar"}}, {:_id => 1})
update({"doc" => {"foo" => "bar"}}, {:id => 1})
update({"doc" => {"foo" => "bar"}}, "_id" => 1)

Returns the response from the bulk call if one was made or nil.

# File lib/elastomer_client/client/bulk.rb, line 288
def update(document, params)
  params = prepare_params(document, params)
  add_to_actions({update: params}, document)
end