class ActiveRecordShards::ShardSelection

Constants

NO_SHARD
PRIMARY

Public Class Methods

new() click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 8
def initialize
  @on_replica = false
  @shard = nil
end

Public Instance Methods

on_replica=(new_replica) click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 82
def on_replica=(new_replica)
  @on_replica = (new_replica == true)
end
Also aliased as: on_slave=
on_replica?() click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 77
def on_replica?
  @on_replica
end
Also aliased as: on_slave?
on_slave=(new_replica)
Alias for: on_replica=
on_slave?()
Alias for: on_replica?
options() click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 87
def options
  { shard: @shard, replica: @on_replica }
end
resolve_connection_name(sharded:, configurations:) click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 51
def resolve_connection_name(sharded:, configurations:)
  resolved_shard = sharded ? shard : nil
  env = ActiveRecordShards.rails_env

  @connection_names ||= {}
  @connection_names[env] ||= {}
  @connection_names[env][resolved_shard] ||= {}
  @connection_names[env][resolved_shard][@on_replica] ||= begin
    name = env.dup
    name << "_shard_#{resolved_shard}" if resolved_shard
    if @on_replica && configurations["#{name}_replica"]
      "#{name}_replica"
    else
      # ActiveRecord always names its default connection pool 'primary'
      # while everything else is named by the configuration name
      resolved_shard ? name : PRIMARY
    end
  end
end
shard(klass = nil) click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 15
def shard(klass = nil)
  if (@shard || self.class.default_shard) && (klass.nil? || klass.is_sharded?)
    if @shard == NO_SHARD
      nil
    else
      @shard || self.class.default_shard
    end
  end
end
shard=(new_shard) click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 73
def shard=(new_shard)
  @shard = (new_shard || NO_SHARD)
end
shard_name(klass = nil, try_replica = true) click to toggle source
# File lib/active_record_shards/shard_selection.rb, line 25
def shard_name(klass = nil, try_replica = true)
  the_shard = shard(klass)

  @shard_names ||= {}
  @shard_names[ActiveRecordShards.rails_env] ||= {}
  @shard_names[ActiveRecordShards.rails_env][the_shard] ||= {}
  @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica] ||= {}
  @shard_names[ActiveRecordShards.rails_env][the_shard][try_replica][@on_replica] ||= begin
    s = ActiveRecordShards.rails_env.dup
    s << "_shard_#{the_shard}" if the_shard
    s << "_replica"            if @on_replica && try_replica
    s
  end
end