Module: Familia::Features::Relationships::Indexing::ModelClassMethods

Defined in:
lib/familia/features/relationships/indexing.rb

Overview

Indexing::ModelClassMethods

Instance Method Summary collapse

Instance Method Details

#ensure_index_field(scope_class, index_name, field_type, opts = {}) ⇒ Object

Ensure proper DataType field is declared for index Similar to ensure_collection_field in participation system

Parameters:

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

    Options forwarded to the DataType declaration (e.g. +class:+ and +reference: true+ so the index hashkey is a proper reference type that works with +each_record+).



151
152
153
154
155
 
# File 'lib/familia/features/relationships/indexing.rb', line 151

def ensure_index_field(scope_class, index_name, field_type, opts = {})
  return if scope_class.method_defined?(index_name) || scope_class.respond_to?(index_name)

  scope_class.send(field_type, index_name, opts)
end

#indexing_relationships ⇒ Object

Get all indexing relationships for this class



141
142
143
 
# File 'lib/familia/features/relationships/indexing.rb', line 141

def indexing_relationships
  @indexing_relationships ||= []
end

#multi_index(field, index_name, within: :class, query: true) ⇒ Object

Define an indexed_by relationship for fast lookups

Define a multi-value index (1:many mapping)

Examples:

Instance-scoped multi-value indexing

multi_index :department, :dept_index, within: Company

Parameters:

  • field (Symbol) —

    The field to index on

  • index_name (Symbol) —

    Name of the index

  • within (Class, Symbol) (defaults to: :class) —

    The scope class providing uniqueness context

  • query (Boolean) (defaults to: true) —

    Whether to generate query methods



106
107
108
109
110
111
112
113
114
 
# File 'lib/familia/features/relationships/indexing.rb', line 106

def multi_index(field, index_name, within: :class, query: true)
  MultiIndexGenerators.setup(
    indexed_class: self,
    field: field,
    index_name: index_name,
    within: within,
    query: query,
  )
end

#unique_index(field, index_name, within: nil, query: true) ⇒ Object

Define a unique index lookup (1:1 mapping)

Examples:

Class-level unique index

unique_index :email, :email_lookup
unique_index :username, :username_lookup, query: false

Instance-scoped unique index

unique_index :badge_number, :badge_index, within: Company

Parameters:

  • field (Symbol) —

    The field to index on

  • index_name (Symbol) —

    Name of the index hash

  • within (Class, Symbol) (defaults to: nil) —

    Optional scope class for instance-scoped unique index

  • query (Boolean) (defaults to: true) —

    Whether to generate query methods



130
131
132
133
134
135
136
137
138
 
# File 'lib/familia/features/relationships/indexing.rb', line 130

def unique_index(field, index_name, within: nil, query: true)
  UniqueIndexGenerators.setup(
    indexed_class: self,
    field: field,
    index_name: index_name,
    within: within,
    query: query,
  )
end