class Blacklight::AbstractRepository
Base class for Blacklight
repository adapters
Attributes
@return [Blacklight::Configuration]
Direct writer for the connection
(Note: ActiveSupport::Benchmarkable requires a logger method) @return [Logger]
Public Class Methods
Source
# File lib/blacklight/abstract_repository.rb, line 20 def initialize blacklight_config @blacklight_config = blacklight_config end
@param [Blacklight::Configuration] blacklight_config
Public Instance Methods
Source
# File lib/blacklight/abstract_repository.rb, line 26 def connection @connection ||= build_connection end
The raw data store connection
Source
# File lib/blacklight/abstract_repository.rb, line 34 def find(_id, _params = {}) raise NotImplementedError end
Find a single document result by a known id @param [String] _id document’s unique key value @param [Hash] _params additional query parameters
Source
# File lib/blacklight/abstract_repository.rb, line 40 def find_many(params, **kwargs) search(params, **kwargs) end
Find multiple documents by their ids @param [Hash] _params query parameters
Source
# File lib/blacklight/abstract_repository.rb, line 59 def ping raise NotImplementedError end
Is the repository in a working state?
Source
# File lib/blacklight/abstract_repository.rb, line 53 def reflect_fields raise NotImplementedError end
Query the fields that exist from the index @return [Hash]
Source
# File lib/blacklight/abstract_repository.rb, line 47 def search(_params = {}) raise NotImplementedError end
Execute a search query against a search index @param [Hash] _params query parameters
Private Instance Methods
Source
# File lib/blacklight/abstract_repository.rb, line 65 def connection_config blacklight_config.connection_config end
Source
# File lib/blacklight/abstract_repository.rb, line 69 def logger @logger ||= Blacklight.logger end