Module: ActiveRecordShards::ConnectionSwitcher
- Defined in:
- lib/active_record_shards/connection_switcher.rb,
lib/active_record_shards/connection_switcher-5-1.rb,
lib/active_record_shards/connection_switcher-6-0.rb
Defined Under Namespace
Classes: PrimaryReplicaProxy
Constant Summary
collapse
- SHARD_NAMES_CONFIG_KEY =
'shard_names'
Class Method Summary
collapse
Instance Method Summary
collapse
Class Method Details
.extended(base) ⇒ Object
9
10
11
12
13
14
15
|
# File 'lib/active_record_shards/connection_switcher.rb', line 9
def self.extended(base)
base.singleton_class.send(:alias_method, :load_schema_without_default_shard!, :load_schema!)
base.singleton_class.send(:alias_method, :load_schema!, :load_schema_with_default_shard!)
base.singleton_class.send(:alias_method, :table_exists_without_default_shard?, :table_exists?)
base.singleton_class.send(:alias_method, :table_exists?, :table_exists_with_default_shard?)
end
|
Instance Method Details
#connection_specification_name ⇒ Object
3
4
5
6
7
8
9
10
11
|
# File 'lib/active_record_shards/connection_switcher-5-1.rb', line 3
def connection_specification_name
name = current_shard_selection.resolve_connection_name(sharded: is_sharded?, configurations: configurations)
unless configurations[name] || name == "primary"
raise ActiveRecord::AdapterNotSpecified, "No database defined by #{name} in your database config. (configurations: #{configurations.to_h.keys.inspect})"
end
name
end
|
#current_shard_id ⇒ Object
131
132
133
|
# File 'lib/active_record_shards/connection_switcher.rb', line 131
def current_shard_id
current_shard_selection.shard
end
|
#current_shard_selection ⇒ Object
127
128
129
|
# File 'lib/active_record_shards/connection_switcher.rb', line 127
def current_shard_selection
Thread.current[:shard_selection] ||= ShardSelection.new
end
|
#default_shard=(new_default_shard) ⇒ Object
17
18
19
20
|
# File 'lib/active_record_shards/connection_switcher.rb', line 17
def default_shard=(new_default_shard)
ActiveRecordShards::ShardSelection.default_shard = new_default_shard
switch_connection(shard: new_default_shard)
end
|
#on_all_shards ⇒ Object
43
44
45
46
47
48
49
50
51
52
53
54
55
|
# File 'lib/active_record_shards/connection_switcher.rb', line 43
def on_all_shards
old_options = current_shard_selection.options
if supports_sharding?
shard_names.map do |shard|
switch_connection(shard: shard)
yield(shard)
end
else
[yield]
end
ensure
switch_connection(old_options)
end
|
#on_cx_switch_block(which, force: false, construct_ro_scope: nil, &block) ⇒ Object
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# File 'lib/active_record_shards/connection_switcher.rb', line 98
def on_cx_switch_block(which, force: false, construct_ro_scope: nil, &block)
@disallow_replica ||= 0
@disallow_replica += 1 if which == :primary
switch_to_replica = force || @disallow_replica.zero?
old_options = current_shard_selection.options
switch_connection(replica: switch_to_replica)
if self == ActiveRecord::Base || !switch_to_replica || construct_ro_scope == false || ActiveRecordShards.disable_replica_readonly_records == true
yield
else
readonly.scoping(&block)
end
ensure
@disallow_replica -= 1 if which == :primary
switch_connection(old_options) if old_options
end
|
#on_first_shard(&block) ⇒ Object
34
35
36
37
|
# File 'lib/active_record_shards/connection_switcher.rb', line 34
def on_first_shard(&block)
shard_name = shard_names.first
on_shard(shard_name, &block)
end
|
#on_primary(&block) ⇒ Object
94
95
96
|
# File 'lib/active_record_shards/connection_switcher.rb', line 94
def on_primary(&block)
on_primary_or_replica(:primary, &block)
end
|
#on_primary_db(&block) ⇒ Object
22
23
24
|
# File 'lib/active_record_shards/connection_switcher.rb', line 22
def on_primary_db(&block)
on_shard(nil, &block)
end
|
#on_primary_if(condition, &block) ⇒ Object
65
66
67
|
# File 'lib/active_record_shards/connection_switcher.rb', line 65
def on_primary_if(condition, &block)
condition ? on_primary(&block) : yield
end
|
#on_primary_or_replica(which, &block) ⇒ Object
73
74
75
76
77
78
79
|
# File 'lib/active_record_shards/connection_switcher.rb', line 73
def on_primary_or_replica(which, &block)
if block_given?
on_cx_switch_block(which, &block)
else
PrimaryReplicaProxy.new(self, which)
end
end
|
#on_primary_unless(condition, &block) ⇒ Object
69
70
71
|
# File 'lib/active_record_shards/connection_switcher.rb', line 69
def on_primary_unless(condition, &block)
on_primary_if(!condition, &block)
end
|
#on_replica(&block) ⇒ Object
Executes queries using the replica database. Fails over to primary if no replica is found. if you want to execute a block of code on the replica you can go:
Account.on_replica do
Account.first
end
the first account will be found on the replica DB
For one-liners you can simply do
Account.on_replica.first
90
91
92
|
# File 'lib/active_record_shards/connection_switcher.rb', line 90
def on_replica(&block)
on_primary_or_replica(:replica, &block)
end
|
#on_replica? ⇒ Boolean
123
124
125
|
# File 'lib/active_record_shards/connection_switcher.rb', line 123
def on_replica?
current_shard_selection.on_replica?
end
|
#on_replica_if(condition, &block) ⇒ Object
57
58
59
|
# File 'lib/active_record_shards/connection_switcher.rb', line 57
def on_replica_if(condition, &block)
condition ? on_replica(&block) : yield
end
|
#on_replica_unless(condition, &block) ⇒ Object
61
62
63
|
# File 'lib/active_record_shards/connection_switcher.rb', line 61
def on_replica_unless(condition, &block)
on_replica_if(!condition, &block)
end
|
#on_shard(shard) ⇒ Object
26
27
28
29
30
31
32
|
# File 'lib/active_record_shards/connection_switcher.rb', line 26
def on_shard(shard)
old_options = current_shard_selection.options
switch_connection(shard: shard) if supports_sharding?
yield
ensure
switch_connection(old_options)
end
|
#shard_names ⇒ Object
135
136
137
138
139
140
141
|
# File 'lib/active_record_shards/connection_switcher.rb', line 135
def shard_names
unless config_for_env.fetch(SHARD_NAMES_CONFIG_KEY, []).all? { |shard_name| shard_name.is_a?(Integer) }
raise "All shard names must be integers: #{config_for_env[SHARD_NAMES_CONFIG_KEY].inspect}."
end
config_for_env[SHARD_NAMES_CONFIG_KEY] || []
end
|
#shards ⇒ Object
39
40
41
|
# File 'lib/active_record_shards/connection_switcher.rb', line 39
def shards
ShardSupport.new(self == ActiveRecord::Base ? nil : where(nil))
end
|
#supports_sharding? ⇒ Boolean
119
120
121
|
# File 'lib/active_record_shards/connection_switcher.rb', line 119
def supports_sharding?
shard_names.any?
end
|