Module: Searchkick

Defined in:
lib/searchkick/indexer.rb,
lib/searchkick.rb,
lib/searchkick/index.rb,
lib/searchkick/model.rb,
lib/searchkick/query.rb,
lib/searchkick/where.rb,
lib/searchkick/script.rb,
lib/searchkick/railtie.rb,
lib/searchkick/results.rb,
lib/searchkick/version.rb,
lib/searchkick/relation.rb,
lib/searchkick/reranking.rb,
lib/searchkick/middleware.rb,
lib/searchkick/index_cache.rb,
lib/searchkick/record_data.rb,
lib/searchkick/hash_wrapper.rb,
lib/searchkick/multi_search.rb,
lib/searchkick/index_options.rb,
lib/searchkick/reindex_queue.rb,
lib/searchkick/log_subscriber.rb,
lib/searchkick/record_indexer.rb,
lib/searchkick/reindex_v2_job.rb,
lib/searchkick/bulk_reindex_job.rb,
lib/searchkick/relation_indexer.rb,
lib/searchkick/process_batch_job.rb,
lib/searchkick/process_queue_job.rb,
lib/searchkick/controller_runtime.rb

Overview

based on gist.github.com/mnutt/566725

Defined Under Namespace

Modules: ControllerRuntime, Model, Reranking Classes: BulkReindexJob, DangerousOperation, Error, HashWrapper, ImportError, Index, IndexCache, IndexOptions, Indexer, InvalidQueryError, LogSubscriber, Middleware, MissingIndexError, MultiSearch, ProcessBatchJob, ProcessQueueJob, Query, Railtie, RecordData, RecordIndexer, ReindexQueue, ReindexV2Job, Relation, RelationIndexer, Results, Script, UnsupportedVersionError, Where

Constant Summary collapse

VERSION = 
"5.5.1"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.aws_credentials ⇒ Object

Returns the value of attribute aws_credentials.



62
63
64
 
# File 'lib/searchkick.rb', line 62

def aws_credentials
  @aws_credentials
end

.client ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/searchkick.rb', line 71

def self.client
  @client ||= begin
    client_type =
      if self.client_type
        self.client_type
      elsif defined?(OpenSearch::Client) && defined?(Elasticsearch::Client)
        raise Error, "Multiple clients found - set Searchkick.client_type = :elasticsearch or :opensearch"
      elsif defined?(OpenSearch::Client)
        :opensearch
      elsif defined?(Elasticsearch::Client)
        :elasticsearch
      else
        raise Error, "No client found - install the `elasticsearch` or `opensearch-ruby` gem"
      end

    # check after client to ensure faraday is installed
    # TODO remove in Searchkick 6
    if defined?(Typhoeus) && Gem::Version.new(Faraday::VERSION) < Gem::Version.new("0.14.0")
      require "typhoeus/adapters/faraday"
    end

    if client_type == :opensearch
      OpenSearch::Client.new({
        url: ENV["OPENSEARCH_URL"],
        # TODO remove headers in Searchkick 6
        transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}},
        retry_on_failure: 2
      }.deep_merge(client_options)) do |f|
        f.use Searchkick::Middleware
        f.request :aws_sigv4, signer_middleware_aws_params if aws_credentials
      end
    else
      raise Error, "The `elasticsearch` gem must be 7+" if Elasticsearch::VERSION.to_i < 7

      transport_options = {request: {timeout: timeout}}
      # TODO remove headers in Searchkick 6
      if Elasticsearch::VERSION.to_i < 9
        transport_options[:headers] = {content_type: "application/json"}
      end

      Elasticsearch::Client.new({
        url: ENV["ELASTICSEARCH_URL"],
        transport_options: transport_options,
        retry_on_failure: 2
      }.deep_merge(client_options)) do |f|
        f.use Searchkick::Middleware
        f.request :aws_sigv4, signer_middleware_aws_params if aws_credentials
      end
    end
  end
end

.client_options ⇒ Object

Returns the value of attribute client_options.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def client_options
  @client_options
end

.client_type ⇒ Object

Returns the value of attribute client_type.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def client_type
  @client_type
end

.env ⇒ Object 



123
124
125
 
# File 'lib/searchkick.rb', line 123

def self.env
  @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development"
end

.index_prefix ⇒ Object

Returns the value of attribute index_prefix.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def index_prefix
  @index_prefix
end

.index_suffix ⇒ Object

Returns the value of attribute index_suffix.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def index_suffix
  @index_suffix
end

.model_options ⇒ Object

Returns the value of attribute model_options.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def model_options
  @model_options
end

.models ⇒ Object

Returns the value of attribute models.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def models
  @models
end

.queue_name ⇒ Object

Returns the value of attribute queue_name.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def queue_name
  @queue_name
end

.redis ⇒ Object

Returns the value of attribute redis.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def redis
  @redis
end

.search_method_name ⇒ Object

Returns the value of attribute search_method_name.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def search_method_name
  @search_method_name
end

.search_timeout ⇒ Object 



127
128
129
 
# File 'lib/searchkick.rb', line 127

def self.search_timeout
  (defined?(@search_timeout) && @search_timeout) || timeout
end

.timeout ⇒ Object

Returns the value of attribute timeout.



60
61
62
 
# File 'lib/searchkick.rb', line 60

def timeout
  @timeout
end

Class Method Details

.callbacks(value = nil, message: nil) ⇒ Object

message is private



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/searchkick.rb', line 236

def self.callbacks(value = nil, message: nil)
  if block_given?
    previous_value = callbacks_value
    begin
      self.callbacks_value = value
      result = yield
      if callbacks_value == :bulk && indexer.queued_items.any?
        event = {}
        if message
          message.call(event)
        else
          event[:name] = "Bulk"
          event[:count] = indexer.queued_items.size
        end
        ActiveSupport::Notifications.instrument("request.searchkick", event) do
          indexer.perform
        end
      end
      result
    ensure
      self.callbacks_value = previous_value
    end
  else
    self.callbacks_value = value
  end
end

.callbacks?(default: true) ⇒ Boolean

Returns:

  • (Boolean) 


227
228
229
230
231
232
233
 
# File 'lib/searchkick.rb', line 227

def self.callbacks?(default: true)
  if callbacks_value.nil?
    default
  else
    callbacks_value != false
  end
end

.callbacks_value ⇒ Object

private



335
336
337
 
# File 'lib/searchkick.rb', line 335

def self.callbacks_value
  Thread.current[:searchkick_callbacks_enabled]
end

.callbacks_value=(value) ⇒ Object

private



340
341
342
 
# File 'lib/searchkick.rb', line 340

def self.callbacks_value=(value)
  Thread.current[:searchkick_callbacks_enabled] = value
end

.disable_callbacks ⇒ Object 



223
224
225
 
# File 'lib/searchkick.rb', line 223

def self.disable_callbacks
  self.callbacks_value = false
end

.enable_callbacks ⇒ Object

callbacks



219
220
221
 
# File 'lib/searchkick.rb', line 219

def self.enable_callbacks
  self.callbacks_value = nil
end

.indexer ⇒ Object

private



330
331
332
 
# File 'lib/searchkick.rb', line 330

def self.indexer
  Thread.current[:searchkick_indexer] ||= Indexer.new
end

.knn_support? ⇒ Boolean

private

Returns:

  • (Boolean) 


154
155
156
157
158
159
160
 
# File 'lib/searchkick.rb', line 154

def self.knn_support?
  if opensearch?
    !server_below?("2.4.0", true)
  else
    !server_below?("8.6.0")
  end
end

.load_model(class_name, allow_child: false) ⇒ Object

public (for reindexing conversions)

Raises:



314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/searchkick.rb', line 314

def self.load_model(class_name, allow_child: false)
  model = class_name.safe_constantize
  raise Error, "Could not find class: #{class_name}" unless model
  if allow_child
    unless model.respond_to?(:searchkick_klass)
      raise Error, "#{class_name} is not a searchkick model"
    end
  else
    unless Searchkick.models.include?(model)
      raise Error, "#{class_name} is not a searchkick model"
    end
  end
  model
end

.load_records(relation, ids) ⇒ Object

private

Raises:



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/searchkick.rb', line 297

def self.load_records(relation, ids)
  relation =
    if relation.respond_to?(:primary_key)
      primary_key = relation.primary_key
      raise Error, "Need primary key to load records" if !primary_key

      relation.where(primary_key => ids)
    elsif relation.respond_to?(:queryable)
      relation.queryable.for_ids(ids)
    end

  raise Error, "Not sure how to load records" if !relation

  relation
end

.multi_search(queries) ⇒ Object 



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/searchkick.rb', line 197

def self.multi_search(queries)
  return if queries.empty?

  queries = queries.map { |q| q.send(:query) }
  event = {
    name: "Multi Search",
    body: queries.flat_map { |q| [q.params.except(:body).to_json, q.body.to_json] }.map { |v| "#{v}\n" }.join
  }
  ActiveSupport::Notifications.instrument("multi_search.searchkick", event) do
    MultiSearch.new(queries).perform
  end
end

.not_allowed_error?(e) ⇒ Boolean

private

Returns:

  • (Boolean) 


388
389
390
391
392
 
# File 'lib/searchkick.rb', line 388

def self.not_allowed_error?(e)
  (defined?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Errors::MethodNotAllowed)) ||
  (defined?(Elasticsearch::Transport) && e.is_a?(Elasticsearch::Transport::Transport::Errors::MethodNotAllowed)) ||
  (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Errors::MethodNotAllowed))
end

.not_found_error?(e) ⇒ Boolean

private

Returns:

  • (Boolean) 


374
375
376
377
378
 
# File 'lib/searchkick.rb', line 374

def self.not_found_error?(e)
  (defined?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Errors::NotFound)) ||
  (defined?(Elasticsearch::Transport) && e.is_a?(Elasticsearch::Transport::Transport::Errors::NotFound)) ||
  (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Errors::NotFound))
end

.opensearch? ⇒ Boolean

Returns:

  • (Boolean) 


140
141
142
143
144
145
 
# File 'lib/searchkick.rb', line 140

def self.opensearch?
  unless defined?(@opensearch)
    @opensearch = server_info["version"]["distribution"] == "opensearch"
  end
  @opensearch
end

.reindex_status(index_name) ⇒ Object

Raises:



270
271
272
273
274
275
276
277
278
 
# File 'lib/searchkick.rb', line 270

def self.reindex_status(index_name)
  raise Error, "Redis not configured" unless redis

  batches_left = Index.new(index_name).batches_left
  {
    completed: batches_left == 0,
    batches_left: batches_left
  }
end

.relation?(klass) ⇒ Boolean

private methods are forwarded to base class this check to see if scope exists on that class it’s a bit tricky, but this seems to work

Returns:

  • (Boolean) 


353
354
355
356
357
358
359
 
# File 'lib/searchkick.rb', line 353

def self.relation?(klass)
  if klass.respond_to?(:current_scope)
    !klass.current_scope.nil?
  else
    klass.is_a?(Mongoid::Criteria) || !Mongoid::Threaded.current_scope(klass).nil?
  end
end

.scope(model) ⇒ Object

private

Raises:



362
363
364
365
366
367
368
369
370
371
 
# File 'lib/searchkick.rb', line 362

def self.scope(model)
  # safety check to make sure used properly in code
  raise Error, "Cannot scope relation" if relation?(model)

  if model.searchkick_options[:unscope]
    model.unscoped
  else
    model
  end
end

.script(source, **options) ⇒ Object

experimental



213
214
215
 
# File 'lib/searchkick.rb', line 213

def self.script(source, **options)
  Script.new(source, **options)
end

.search(term = "*", model: nil, **options, &block) ⇒ Object 



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
187
188
189
190
191
192
193
194
195
 
# File 'lib/searchkick.rb', line 162

def self.search(term = "*", model: nil, **options, &block)
  options = options.dup
  klass = model

  # convert index_name into models if possible
  # this should allow for easier upgrade
  if options[:index_name] && !options[:models] && Array(options[:index_name]).all? { |v| v.respond_to?(:searchkick_index) }
    options[:models] = options.delete(:index_name)
  end

  # make Searchkick.search(models: [Product]) and Product.search equivalent
  unless klass
    models = Array(options[:models])
    if models.size == 1
      klass = models.first
      options.delete(:models)
    end
  end

  if klass
    if (options[:models] && Array(options[:models]) != [klass]) || Array(options[:index_name]).any? { |v| v.respond_to?(:searchkick_index) && v != klass }
      raise ArgumentError, "Use Searchkick.search to search multiple models"
    end
  end

  # TODO remove in Searchkick 6
  if options[:execute] == false
    Searchkick.warn("The execute option is no longer needed")
    options.delete(:execute)
  end

  options = options.merge(block: block) if block
  Relation.new(klass, term, **options)
end

.server_below?(version, true_version = false) ⇒ Boolean

TODO always check true version in Searchkick 6

Returns:

  • (Boolean) 


148
149
150
151
 
# File 'lib/searchkick.rb', line 148

def self.server_below?(version, true_version = false)
  server_version = !true_version && opensearch? ? "7.10.2" : self.server_version
  Gem::Version.new(server_version.split("-")[0]) < Gem::Version.new(version.split("-")[0])
end

.server_info ⇒ Object

private



132
133
134
 
# File 'lib/searchkick.rb', line 132

def self.server_info
  @server_info ||= client.info
end

.server_version ⇒ Object 



136
137
138
 
# File 'lib/searchkick.rb', line 136

def self.server_version
  @server_version ||= server_info["version"]["number"]
end

.signer_middleware_aws_params ⇒ Object

private



345
346
347
 
# File 'lib/searchkick.rb', line 345

def self.signer_middleware_aws_params
  {service: "es", region: "us-east-1"}.merge(aws_credentials)
end

.transport_error?(e) ⇒ Boolean

private

Returns:

  • (Boolean) 


381
382
383
384
385
 
# File 'lib/searchkick.rb', line 381

def self.transport_error?(e)
  (defined?(Elastic::Transport) && e.is_a?(Elastic::Transport::Transport::Error)) ||
  (defined?(Elasticsearch::Transport) && e.is_a?(Elasticsearch::Transport::Transport::Error)) ||
  (defined?(OpenSearch) && e.is_a?(OpenSearch::Transport::Transport::Error))
end

.warn(message) ⇒ Object 



292
293
294
 
# File 'lib/searchkick.rb', line 292

def self.warn(message)
  super("[searchkick] WARNING: #{message}")
end

.with_redis ⇒ Object 



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/searchkick.rb', line 280

def self.with_redis
  if redis
    if redis.respond_to?(:with)
      redis.with do |r|
        yield r
      end
    else
      yield redis
    end
  end
end