Module: Elasticsearch::Model::Indexing::InstanceMethods

Included in:
Proxy::InstanceMethodsProxy
Defined in:
lib/elasticsearch/model/indexing.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/elasticsearch/model/indexing.rb', line 331

def self.included(base)
  # Register callback for storing changed attributes for models
  # which implement `before_save` and return changed attributes
  # (ie. when `Elasticsearch::Model` is included)
  #
  # @note This is typically triggered only when the module would be
  #       included in the model directly, not within the proxy.
  #
  # @see #update_document
  #
  base.before_save do |obj|
    if obj.respond_to?(:changes_to_save) # Rails 5.1
      changes_to_save = obj.changes_to_save
    elsif obj.respond_to?(:changes)
      changes_to_save = obj.changes
    end

    if changes_to_save
      attrs = obj.instance_variable_get(:@__changed_model_attributes) || {}
      latest_changes = changes_to_save.inject({}) { |latest_changes, (k,v)| latest_changes.merge!(k => v.last) }
      obj.instance_variable_set(:@__changed_model_attributes, attrs.merge(latest_changes))
    end
  end if base.respond_to?(:before_save)
end

Instance Method Details

#delete_document(options = {}) ⇒ Hash

Deletes the model instance from the index

Examples:

Delete a record


@article.__elasticsearch__.delete_document
2013-11-20 16:27:00 +0100: DELETE http://localhost:9200/articles/article/1

Parameters:

  • options (Hash) (defaults to: {}) —

    Optional arguments for passing to the client

Returns:

  • (Hash) —

    The response from Elasticsearch

See Also:



393
394
395
396
397
398
399
 
# File 'lib/elasticsearch/model/indexing.rb', line 393

def delete_document(options={})
  request = { index: index_name,
              id:    self.id }
  request.merge!(type: document_type) if document_type

  client.delete(request.merge!(options))
end

#index_document(options = {}) ⇒ Hash

Serializes the model instance into JSON (by calling ‘as_indexed_json`), and saves the document into the Elasticsearch index.

Examples:

Index a record


@article.__elasticsearch__.index_document
2013-11-20 16:25:57 +0100: PUT http://localhost:9200/articles/article/1 ...

Parameters:

  • options (Hash) (defaults to: {}) —

    Optional arguments for passing to the client

Returns:

  • (Hash) —

    The response from Elasticsearch

See Also:



370
371
372
373
374
375
376
377
378
 
# File 'lib/elasticsearch/model/indexing.rb', line 370

def index_document(options={})
  document = as_indexed_json
  request = { index: index_name,
              id:    id,
              body:  document }
  request.merge!(type: document_type) if document_type

  client.index(request.merge!(options))
end

#update_document(options = {}) ⇒ Hash

Tries to gather the changed attributes of a model instance (via [ActiveModel::Dirty](api.rubyonrails.org/classes/ActiveModel/Dirty.html)), performing a partial update of the document.

When the changed attributes are not available, performs full re-index of the record.

See the #update_document_attributes method for updating specific attributes directly.

Examples:

Update a document corresponding to the record


@article = Article.first
@article.update_attribute :title, 'Updated'
# SQL (0.3ms)  UPDATE "articles" SET "title" = ?...

@article.__elasticsearch__.update_document
# 2013-11-20 17:00:05 +0100: POST http://localhost:9200/articles/article/1/_update ...
# 2013-11-20 17:00:05 +0100: > {"doc":{"title":"Updated"}}

Parameters:

  • options (Hash) (defaults to: {}) —

    Optional arguments for passing to the client

Returns:

  • (Hash) —

    The response from Elasticsearch

See Also:



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/elasticsearch/model/indexing.rb', line 425

def update_document(options={})
  if attributes_in_database = self.instance_variable_get(:@__changed_model_attributes).presence
    attributes = if respond_to?(:as_indexed_json)
      self.as_indexed_json.select { |k,v| attributes_in_database.keys.map(&:to_s).include? k.to_s }
    else
      attributes_in_database
    end

    unless attributes.empty?
      request = { index: index_name,
                  id:    self.id,
                  body:  { doc: attributes } }
      request.merge!(type: document_type) if document_type

      client.update(request.merge!(options))
    end
  else
    index_document(options)
  end
end

#update_document_attributes(attributes, options = {}) ⇒ Hash

Perform a partial update of specific document attributes (without consideration for changed attributes as in #update_document)

Examples:

Update the ‘title` attribute


@article = Article.first
@article.title = "New title"
@article.__elasticsearch__.update_document_attributes title: "New title"

Parameters:

  • attributes (Hash) —

    Attributes to be updated

  • options (Hash) (defaults to: {}) —

    Optional arguments for passing to the client

Returns:

  • (Hash) —

    The response from Elasticsearch



460
461
462
463
464
465
466
467
 
# File 'lib/elasticsearch/model/indexing.rb', line 460

def update_document_attributes(attributes, options={})
  request = { index: index_name,
              id:    self.id,
              body:  { doc: attributes } }
  request.merge!(type: document_type) if document_type

  client.update(request.merge!(options))
end