Class: Blacklight::AbstractRepository

Inherits:
Object
  • Object
show all
Includes:
ActiveSupport::Benchmarkable
Defined in:
lib/blacklight/abstract_repository.rb

Overview

Base class for Blacklight repository adapters

Direct Known Subclasses

Solr::Repository

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(blacklight_config) ⇒ AbstractRepository

Returns a new instance of AbstractRepository.

Parameters:



19
20
21
 
# File 'lib/blacklight/abstract_repository.rb', line 19

def initialize blacklight_config
  @blacklight_config = blacklight_config
end

Instance Attribute Details

#blacklight_config ⇒ Blacklight::Configuration

Returns:



6
7
8
 
# File 'lib/blacklight/abstract_repository.rb', line 6

def blacklight_config
  @blacklight_config
end

#connection ⇒ Object

The raw data store connection



25
26
27
 
# File 'lib/blacklight/abstract_repository.rb', line 25

def connection
  @connection ||= build_connection
end

#logger=(value) ⇒ Logger

(Note: ActiveSupport::Benchmarkable requires a logger method)

Returns:

  • (Logger) 


13
14
15
 
# File 'lib/blacklight/abstract_repository.rb', line 13

def logger=(value)
  @logger = value
end

Instance Method Details

#find(_id, _params = {}) ⇒ Object

Find a single document result by a known id

Parameters:

  • _id (String) —

    document’s unique key value

  • _params (Hash) (defaults to: {}) —

    additional query parameters

Raises:

  • (NotImplementedError) 


33
34
35
 
# File 'lib/blacklight/abstract_repository.rb', line 33

def find(_id, _params = {})
  raise NotImplementedError
end

#find_many(params, **kwargs) ⇒ Object

Find multiple documents by their ids

Parameters:

  • _params (Hash) —

    query parameters



39
40
41
 
# File 'lib/blacklight/abstract_repository.rb', line 39

def find_many(params, **kwargs)
  search(params, **kwargs)
end

#ping ⇒ Object

Is the repository in a working state?

Raises:

  • (NotImplementedError) 


58
59
60
 
# File 'lib/blacklight/abstract_repository.rb', line 58

def ping
  raise NotImplementedError
end

#reflect_fields ⇒ Hash

Query the fields that exist from the index

Returns:

  • (Hash)

Raises:

  • (NotImplementedError) 


52
53
54
 
# File 'lib/blacklight/abstract_repository.rb', line 52

def reflect_fields
  raise NotImplementedError
end

#search(_params = {}) ⇒ Object

Execute a search query against a search index

Parameters:

  • _params (Hash) (defaults to: {}) —

    query parameters

Raises:

  • (NotImplementedError) 


46
47
48
 
# File 'lib/blacklight/abstract_repository.rb', line 46

def search(_params = {})
  raise NotImplementedError
end