Class: Searchkick::Query

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/searchkick/query.rb

Constant Summary collapse

@@metric_aggs =
[:avg, :cardinality, :max, :min, :sum]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klass, term = "*", **options) ⇒ Query

Returns a new instance of Query.

Raises:

  • (ArgumentError)

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/searchkick/query.rb', line 17

def initialize(klass, term = "*", **options)
  unknown_keywords = options.keys - [:aggs, :block, :body, :body_options, :boost,
    :boost_by, :boost_by_distance, :boost_by_recency, :boost_where, :conversions, :conversions_term, :debug, :emoji, :exclude, :execute, :explain,
    :fields, :highlight, :includes, :index_name, :indices_boost, :limit, :load,
    :match, :misspellings, :models, :model_includes, :offset, :operator, :order, :padding, :page, :per_page, :profile,
    :request_params, :routing, :scope_results, :scroll, :select, :similar, :smart_aggs, :suggest, :total_entries, :track, :type, :where]
  raise ArgumentError, "unknown keywords: #{unknown_keywords.join(", ")}" if unknown_keywords.any?

  term = term.to_s

  if options[:emoji]
    term = EmojiParser.parse_unicode(term) { |e| " #{e.name} " }.strip
  end

  @klass = klass
  @term = term
  @options = options
  @match_suffix = options[:match] || searchkick_options[:match] || "analyzed"

  # prevent Ruby warnings
  @type = nil
  @routing = nil
  @misspellings = false
  @misspellings_below = nil
  @highlighted_fields = nil
  @index_mapping = nil

  prepare
end

Instance Attribute Details

#bodyObject

Returns the value of attribute body


8
9
10
# File 'lib/searchkick/query.rb', line 8

def body
  @body
end

#klassObject (readonly)

Returns the value of attribute klass


7
8
9
# File 'lib/searchkick/query.rb', line 7

def klass
  @klass
end

#optionsObject (readonly)

Returns the value of attribute options


7
8
9
# File 'lib/searchkick/query.rb', line 7

def options
  @options
end

#termObject (readonly)

Returns the value of attribute term


7
8
9
# File 'lib/searchkick/query.rb', line 7

def term
  @term
end

Instance Method Details

#executeObject


90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/searchkick/query.rb', line 90

def execute
  @execute ||= begin
    begin
      response = execute_search
      if retry_misspellings?(response)
        prepare
        response = execute_search
      end
    rescue => e # TODO rescue type
      handle_error(e)
    end
    handle_response(response)
  end
end

#handle_response(response) ⇒ Object


121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
# File 'lib/searchkick/query.rb', line 121

def handle_response(response)
  opts = {
    page: @page,
    per_page: @per_page,
    padding: @padding,
    load: @load,
    includes: options[:includes],
    model_includes: options[:model_includes],
    json: !@json.nil?,
    match_suffix: @match_suffix,
    highlight: options[:highlight],
    highlighted_fields: @highlighted_fields || [],
    misspellings: @misspellings,
    term: term,
    scope_results: options[:scope_results],
    total_entries: options[:total_entries],
    index_mapping: @index_mapping,
    suggest: options[:suggest],
    scroll: options[:scroll]
  }

  if options[:debug]
    # can remove when minimum Ruby version is 2.5
    require "pp"

    puts "Searchkick Version: #{Searchkick::VERSION}"
    puts "Elasticsearch Version: #{Searchkick.server_version}"
    puts

    puts "Model Searchkick Options"
    pp searchkick_options
    puts

    puts "Search Options"
    pp options
    puts

    if searchkick_index
      puts "Model Search Data"
      begin
        pp klass.limit(3).map { |r| RecordData.new(searchkick_index, r).index_data }
      rescue => e
        puts "#{e.class.name}: #{e.message}"
      end
      puts

      puts "Elasticsearch Mapping"
      puts JSON.pretty_generate(searchkick_index.mapping)
      puts

      puts "Elasticsearch Settings"
      puts JSON.pretty_generate(searchkick_index.settings)
      puts
    end

    puts "Elasticsearch Query"
    puts to_curl
    puts

    puts "Elasticsearch Results"
    puts JSON.pretty_generate(response)
  end

  # set execute for multi search
  @execute = Searchkick::Results.new(searchkick_klass, response, opts)
end

#paramsObject


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/searchkick/query.rb', line 59

def params
  if options[:models]
    @index_mapping = {}
    Array(options[:models]).each do |model|
      # there can be multiple models per index name due to inheritance - see #1259
      (@index_mapping[model.searchkick_index.name] ||= []) << model
    end
  end

  index =
    if options[:index_name]
      Array(options[:index_name]).map { |v| v.respond_to?(:searchkick_index) ? v.searchkick_index.name : v }.join(",")
    elsif options[:models]
      @index_mapping.keys.join(",")
    elsif searchkick_index
      searchkick_index.name
    else
      "_all"
    end

  params = {
    index: index,
    body: body
  }
  params[:type] = @type if @type
  params[:routing] = @routing if @routing
  params[:scroll] = @scroll if @scroll
  params.merge!(options[:request_params]) if options[:request_params]
  params
end

#retry_misspellings?(response) ⇒ Boolean

Returns:

  • (Boolean)

188
189
190
# File 'lib/searchkick/query.rb', line 188

def retry_misspellings?(response)
  @misspellings_below && Searchkick::Results.new(searchkick_klass, response).total_count < @misspellings_below
end

#searchkick_indexObject


47
48
49
# File 'lib/searchkick/query.rb', line 47

def searchkick_index
  klass ? klass.searchkick_index : nil
end

#searchkick_klassObject


55
56
57
# File 'lib/searchkick/query.rb', line 55

def searchkick_klass
  klass ? klass.searchkick_klass : nil
end

#searchkick_optionsObject


51
52
53
# File 'lib/searchkick/query.rb', line 51

def searchkick_options
  klass ? klass.searchkick_options : {}
end

#to_curlObject


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/searchkick/query.rb', line 105

def to_curl
  query = params
  type = query[:type]
  index = query[:index].is_a?(Array) ? query[:index].join(",") : query[:index]
  request_params = query.except(:index, :type, :body)

  # no easy way to tell which host the client will use
  host = Searchkick.client.transport.hosts.first
  credentials = host[:user] || host[:password] ? "#{host[:user]}:#{host[:password]}@" : nil
  params = ["pretty"]
  request_params.each do |k, v|
    params << "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}"
  end
  "curl #{host[:protocol]}://#{credentials}#{host[:host]}:#{host[:port]}/#{CGI.escape(index)}#{type ? "/#{type.map { |t| CGI.escape(t) }.join(',')}" : ''}/_search?#{params.join('&')} -H 'Content-Type: application/json' -d '#{query[:body].to_json}'"
end