Sha256: dd75ab47aa695632eeda2494f95f92b842d70a2f679cbc760eedc80b687ae646

Contents?: true

Size: 963 Bytes

Versions: 6

Compression:

Stored size: 963 Bytes

Contents

module Index

  # An index that is persisted in files, loaded at startup and kept in memory at runtime.
  #
  class Memory < Base

    # Create a new memory index for indexing and for querying.
    #
    # Parameters:
    # * name: The identifier of the index. Used:
    #   - to identify an index (e.g. by you in Rake tasks: Indexes[:the_identifier]).
    #   - in the frontend to describe which index a result came from.
    #   - index directory naming (index/development/the_identifier/<lots of indexes>)
    # * source: The source the data comes from. See Sources::Base.
    #
    # Options:
    # * result_identifier: Use if you'd like a different identifier/name in the results JSON than the name of the index.
    #
    def initialize name, options = {}
      options[:indexing_bundle_class] ||= Internals::Indexing::Bundle::Memory
      options[:indexed_bundle_class]  ||= Internals::Indexed::Bundle::Memory

      super name, options
    end

  end

end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
picky-2.5.2 lib/picky/index/memory.rb
picky-2.5.1 lib/picky/index/memory.rb
picky-2.5.0 lib/picky/index/memory.rb
picky-2.4.3 lib/picky/index/memory.rb
picky-2.4.2 lib/picky/index/memory.rb
picky-2.4.1 lib/picky/index/memory.rb