Class: Chewy::Search::Response

Inherits:
Object
  • Object
show all
Defined in:
lib/chewy/search/response.rb

Overview

This class is a ES response hash wrapper.

See Also:

Instance Method Summary collapse

Constructor Details

#initialize(body, loader, paginator = nil) ⇒ Response

Returns a new instance of Response.

Parameters:



9
10
11
12
13
 
# File 'lib/chewy/search/response.rb', line 9

def initialize(body, loader, paginator = nil)
  @body = body
  @loader = loader
  @paginator = paginator
end

Instance Method Details

#aggs ⇒ Hash Also known as: aggregations

The aggregations response part. Returns empty hash if aggregations were not requested.

Returns:

  • (Hash) 


69
70
71
 
# File 'lib/chewy/search/response.rb', line 69

def aggs
  @aggs ||= @body['aggregations'] || {}
end

#hits ⇒ Array<Hash>

Raw response hits collection. Returns empty array is something went wrong.

Returns:

  • (Array<Hash>) 


18
19
20
 
# File 'lib/chewy/search/response.rb', line 18

def hits
  @hits ||= hits_root['hits'] || []
end

#max_score ⇒ Float

Response max_score field.

Returns:

  • (Float) 


32
33
34
 
# File 'lib/chewy/search/response.rb', line 32

def max_score
  @max_score ||= hits_root['max_score']
end

#object_hash ⇒ {Chewy::Index => Object} Also known as: record_hash, document_hash

This method is used in cases when you need to iterate through both of the collections simultaneously.

Examples:

scope.each do |wrapper|
  scope.object_hash[wrapper]
end

Returns:

  • ({Chewy::Index => Object}) —

    a hash with wrappers as keys and ORM/ODM objects as values

See Also:



113
114
115
 
# File 'lib/chewy/search/response.rb', line 113

def object_hash
  @object_hash ||= wrappers.zip(objects).to_h
end

#objects ⇒ Array<Object> Also known as: records, documents

ORM/ODM objects that had been a source for Chewy import and now loaded from the DB using hits ids. Uses Chewy::Search::Request#load passed options for loading.

Returns:

  • (Array<Object>)

See Also:



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/chewy/search/response.rb', line 90

def objects
  @objects ||= begin
    objects = @loader.load(hits)
    if @paginator
      @paginator.call(objects)
    else
      objects
    end
  end
end

#suggest ⇒ Hash

The suggest response part. Returns empty hash if suggests were not requested.

Returns:

  • (Hash) 


61
62
63
 
# File 'lib/chewy/search/response.rb', line 61

def suggest
  @suggest ||= @body['suggest'] || {}
end

#terminated_early? ⇒ true, false

Has the request been terminated early?

Returns:

  • (true, false) 


53
54
55
 
# File 'lib/chewy/search/response.rb', line 53

def terminated_early?
  @terminated_early ||= @body['terminated_early']
end

#timed_out? ⇒ true, false

Has the request been timed out?

Returns:

  • (true, false) 


46
47
48
 
# File 'lib/chewy/search/response.rb', line 46

def timed_out?
  @timed_out ||= @body['timed_out']
end

#took ⇒ Integer

Duration of the request handling in ms according to ES.

Returns:

  • (Integer) 


39
40
41
 
# File 'lib/chewy/search/response.rb', line 39

def took
  @took ||= @body['took']
end

#total ⇒ Integer

Response total field. Returns 0 if something went wrong.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/chewy/search/response.rb', line 25

def total
  @total ||= hits_root.fetch('total', {}).fetch('value', 0)
end

#wrappers ⇒ Array<Chewy::Index>

Index wrappers collection instantiated on top of hits.

Returns:



77
78
79
80
81
 
# File 'lib/chewy/search/response.rb', line 77

def wrappers
  @wrappers ||= hits.map do |hit|
    @loader.derive_index(hit['_index']).build(hit)
  end
end