module Searchkick
Constants
- VERSION
Attributes
aws_credentials[R]
client[W]
client_options[RW]
default_analyzed_analyzer[RW]
env[W]
index_prefix[RW]
index_suffix[RW]
models[RW]
queue_name[RW]
redis[RW]
search_method_name[RW]
search_timeout[W]
searchkick_search2_analyzer[RW]
searchkick_search_analyzer[RW]
timeout[RW]
wordnet_path[RW]
Public Class Methods
aws_credentials=(creds)
click to toggle source
# File lib/searchkick.rb, line 142 def self.aws_credentials=(creds) require "faraday_middleware/aws_signers_v4" @aws_credentials = creds @client = nil # reset client end
callbacks(value) { || ... }
click to toggle source
# File lib/searchkick.rb, line 127 def self.callbacks(value) if block_given? previous_value = callbacks_value begin self.callbacks_value = value yield indexer.perform if callbacks_value == :bulk ensure self.callbacks_value = previous_value end else self.callbacks_value = value end end
callbacks?()
click to toggle source
# File lib/searchkick.rb, line 123 def self.callbacks? Thread.current[:searchkick_callbacks_enabled].nil? || Thread.current[:searchkick_callbacks_enabled] end
callbacks_value()
click to toggle source
private
# File lib/searchkick.rb, line 199 def self.callbacks_value Thread.current[:searchkick_callbacks_enabled] end
callbacks_value=(value)
click to toggle source
private
# File lib/searchkick.rb, line 204 def self.callbacks_value=(value) Thread.current[:searchkick_callbacks_enabled] = value end
client()
click to toggle source
# File lib/searchkick.rb, line 55 def self.client @client ||= begin require "typhoeus/adapters/faraday" if defined?(Typhoeus) Elasticsearch::Client.new({ url: ENV["ELASTICSEARCH_URL"], transport_options: {request: {timeout: timeout}, headers: {content_type: "application/json"}} }.deep_merge(client_options)) do |f| f.use Searchkick::Middleware f.request :aws_signers_v4, { credentials: Aws::Credentials.new(aws_credentials[:access_key_id], aws_credentials[:secret_access_key]), service_name: "es", region: aws_credentials[:region] || "us-east-1" } if aws_credentials end end end
disable_callbacks()
click to toggle source
# File lib/searchkick.rb, line 119 def self.disable_callbacks self.callbacks_value = false end
enable_callbacks()
click to toggle source
callbacks
# File lib/searchkick.rb, line 115 def self.enable_callbacks self.callbacks_value = nil end
env()
click to toggle source
# File lib/searchkick.rb, line 73 def self.env @env ||= ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development" end
indexer()
click to toggle source
private
# File lib/searchkick.rb, line 194 def self.indexer Thread.current[:searchkick_indexer] ||= Searchkick::Indexer.new end
load_records(records, ids)
click to toggle source
private
# File lib/searchkick.rb, line 173 def self.load_records(records, ids) records = if records.respond_to?(:primary_key) # ActiveRecord records.where(records.primary_key => ids) if records.primary_key elsif records.respond_to?(:queryable) # Mongoid 3+ records.queryable.for_ids(ids) elsif records.respond_to?(:unscoped) && :id.respond_to?(:in) # Nobrainer records.unscoped.where(:id.in => ids) elsif records.respond_to?(:key_column_names) records.where(records.key_column_names.first => ids) end raise Searchkick::Error, "Not sure how to load records" if !records records end
multi_search(queries, retry_misspellings: false)
click to toggle source
# File lib/searchkick.rb, line 109 def self.multi_search(queries, retry_misspellings: false) Searchkick::MultiSearch.new(queries, retry_misspellings: retry_misspellings).perform end
reindex_status(index_name)
click to toggle source
# File lib/searchkick.rb, line 148 def self.reindex_status(index_name) if redis batches_left = Searchkick::Index.new(index_name).batches_left { completed: batches_left == 0, batches_left: batches_left } else raise Searchkick::Error, "Redis not configured" end end
search(term = "*", **options, &block)
click to toggle source
# File lib/searchkick.rb, line 89 def self.search(term = "*", **options, &block) klass = options[:model] # TODO add in next major version # if !klass # index_name = Array(options[:index_name]) # if index_name.size == 1 && index_name.first.respond_to?(:searchkick_index) # klass = index_name.first # end # end query = Searchkick::Query.new(klass, term, options.except(:model)) block.call(query.body) if block if options[:execute] == false query else query.execute end end
search_timeout()
click to toggle source
# File lib/searchkick.rb, line 77 def self.search_timeout @search_timeout || timeout end
server_below?(version)
click to toggle source
# File lib/searchkick.rb, line 85 def self.server_below?(version) Gem::Version.new(server_version.sub("-", ".")) < Gem::Version.new(version.sub("-", ".")) end
server_version()
click to toggle source
# File lib/searchkick.rb, line 81 def self.server_version @server_version ||= client.info["version"]["number"] end
with_redis() { |r| ... }
click to toggle source
# File lib/searchkick.rb, line 160 def self.with_redis if redis if redis.respond_to?(:with) redis.with do |r| yield r end else yield redis end end end