Module: ActiveRecordShards::Model

Included in:
ActiveRecord::Base
Defined in:
lib/active_record_shards/model.rb

Defined Under Namespace

Modules: InstanceMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



65
66
67
68
 
# File 'lib/active_record_shards/model.rb', line 65

def self.extended(base)
  base.send(:include, InstanceMethods)
  base.after_initialize :initialize_shard_and_replica
end

Instance Method Details

#is_sharded? ⇒ Boolean

rubocop:disable Naming/PredicateName

Returns:

  • (Boolean) 


13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/active_record_shards/model.rb', line 13

def is_sharded? # rubocop:disable Naming/PredicateName
  if self == ActiveRecord::Base
    sharded != false && supports_sharding?
  elsif self == base_class
    if sharded.nil?
      ActiveRecord::Base.is_sharded?
    else
      sharded != false
    end
  else
    base_class.is_sharded?
  end
end

#not_sharded ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/active_record_shards/model.rb', line 5

def not_sharded
  if self != ActiveRecord::Base && self != base_class
    raise "You should only call not_sharded on direct descendants of ActiveRecord::Base"
  end

  self.sharded = false
end

#on_replica_by_default=(value) ⇒ Object Also known as: on_slave_by_default= 



39
40
41
42
43
44
45
 
# File 'lib/active_record_shards/model.rb', line 39

def on_replica_by_default=(value)
  if self == ActiveRecord::Base
    raise ArgumentError, "Cannot set on_replica_by_default on ActiveRecord::Base"
  else
    base_class.instance_variable_set(:@on_replica_by_default, value)
  end
end

#on_replica_by_default? ⇒ Boolean Also known as: on_slave_by_default?

Returns:

  • (Boolean) 


27
28
29
30
31
32
33
34
35
36
 
# File 'lib/active_record_shards/model.rb', line 27

def on_replica_by_default?
  if self == ActiveRecord::Base
    false
  else
    base = base_class
    if base.instance_variable_defined?(:@on_replica_by_default)
      base.instance_variable_get(:@on_replica_by_default)
    end
  end
end