class ActiveRecord::DatabaseConfigurations

ActiveRecord::DatabaseConfigurations returns an array of DatabaseConfig objects (either a HashConfig or UrlConfig) that are constructed from the application's database configuration hash or URL string.

Attributes

configurations[R]

Public Class Methods

new(configurations = {}) click to toggle source
# File lib/active_record/database_configurations.rb, line 16
def initialize(configurations = {})
  @configurations = build_configs(configurations)
end

Public Instance Methods

[](env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s)
Alias for: default_hash
blank?()
Alias for: empty?
configs_for(env_name: nil, spec_name: nil, include_replicas: false) click to toggle source

Collects the configs for the environment and optionally the specification name passed in. To include replica configurations pass include_replicas: true.

If a spec name is provided a single DatabaseConfig object will be returned, otherwise an array of DatabaseConfig objects will be returned that corresponds with the environment and type requested.

Options

  • env_name: The environment name. Defaults to nil which will collect configs for all environments.

  • spec_name: The specification name (i.e. primary, animals, etc.). Defaults to nil.

  • include_replicas: Determines whether to include replicas in the returned list. Most of the time we're only iterating over the write connection (i.e. migrations don't need to run for the write and read connection). Defaults to false.

# File lib/active_record/database_configurations.rb, line 37
def configs_for(env_name: nil, spec_name: nil, include_replicas: false)
  configs = env_with_configs(env_name)

  unless include_replicas
    configs = configs.select do |db_config|
      !db_config.replica?
    end
  end

  if spec_name
    configs.find do |db_config|
      db_config.spec_name == spec_name
    end
  else
    configs
  end
end
default_hash(env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s) click to toggle source

Returns the config hash that corresponds with the environment

If the application has multiple databases default_hash will return the first config hash for the environment.

{ database: "my_db", adapter: "mysql2" }
# File lib/active_record/database_configurations.rb, line 61
def default_hash(env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s)
  default = find_db_config(env)
  default.config if default
end
Also aliased as: []
each() { |env_name, config| ... } click to toggle source
# File lib/active_record/database_configurations.rb, line 95
def each
  throw_getter_deprecation(:each)
  configurations.each { |config|
    yield [config.env_name, config.config]
  }
end
empty?() click to toggle source

Checks if the application's configurations are empty.

Aliased to blank?

# File lib/active_record/database_configurations.rb, line 90
def empty?
  configurations.empty?
end
Also aliased as: blank?
find_db_config(env) click to toggle source

Returns a single DatabaseConfig object based on the requested environment.

If the application has multiple databases find_db_config will return the first DatabaseConfig for the environment.

# File lib/active_record/database_configurations.rb, line 71
def find_db_config(env)
  configurations.find do |db_config|
    db_config.env_name == env.to_s ||
      (db_config.for_current_env? && db_config.spec_name == env.to_s)
  end
end
first() click to toggle source
# File lib/active_record/database_configurations.rb, line 102
def first
  throw_getter_deprecation(:first)
  config = configurations.first
  [config.env_name, config.config]
end
to_h() click to toggle source

Returns the DatabaseConfigurations object as a Hash.

# File lib/active_record/database_configurations.rb, line 79
def to_h
  configs = configurations.reverse.inject({}) do |memo, db_config|
    memo.merge(db_config.to_legacy_hash)
  end

  Hash[configs.to_a.reverse]
end

Private Instance Methods

build_configs(configs) click to toggle source
# File lib/active_record/database_configurations.rb, line 117
def build_configs(configs)
  return configs.configurations if configs.is_a?(DatabaseConfigurations)
  return configs if configs.is_a?(Array)

  db_configs = configs.flat_map do |env_name, config|
    if config.is_a?(Hash) && config.all? { |_, v| v.is_a?(Hash) }
      walk_configs(env_name.to_s, config)
    else
      build_db_config_from_raw_config(env_name.to_s, "primary", config)
    end
  end

  current_env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s

  unless db_configs.find(&:for_current_env?)
    db_configs << environment_url_config(current_env, "primary", {})
  end

  merge_db_environment_variables(current_env, db_configs.compact)
end
build_db_config_from_hash(env_name, spec_name, config) click to toggle source
# File lib/active_record/database_configurations.rb, line 165
def build_db_config_from_hash(env_name, spec_name, config)
  if config.has_key?("url")
    url = config["url"]
    config_without_url = config.dup
    config_without_url.delete "url"

    ActiveRecord::DatabaseConfigurations::UrlConfig.new(env_name, spec_name, url, config_without_url)
  else
    ActiveRecord::DatabaseConfigurations::HashConfig.new(env_name, spec_name, config)
  end
end
build_db_config_from_raw_config(env_name, spec_name, config) click to toggle source
# File lib/active_record/database_configurations.rb, line 144
def build_db_config_from_raw_config(env_name, spec_name, config)
  case config
  when String
    build_db_config_from_string(env_name, spec_name, config)
  when Hash
    build_db_config_from_hash(env_name, spec_name, config.stringify_keys)
  else
    raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash."
  end
end
build_db_config_from_string(env_name, spec_name, config) click to toggle source
# File lib/active_record/database_configurations.rb, line 155
def build_db_config_from_string(env_name, spec_name, config)
  url = config
  uri = URI.parse(url)
  if uri.scheme
    ActiveRecord::DatabaseConfigurations::UrlConfig.new(env_name, spec_name, url)
  else
    raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash."
  end
end
env_with_configs(env = nil) click to toggle source
# File lib/active_record/database_configurations.rb, line 109
def env_with_configs(env = nil)
  if env
    configurations.select { |db_config| db_config.env_name == env }
  else
    configurations
  end
end
environment_url_config(env, spec_name, config) click to toggle source
# File lib/active_record/database_configurations.rb, line 186
def environment_url_config(env, spec_name, config)
  url = environment_value_for(spec_name)
  return unless url

  ActiveRecord::DatabaseConfigurations::UrlConfig.new(env, spec_name, url, config)
end
environment_value_for(spec_name) click to toggle source
# File lib/active_record/database_configurations.rb, line 193
def environment_value_for(spec_name)
  spec_env_key = "#{spec_name.upcase}_DATABASE_URL"
  url = ENV[spec_env_key]
  url ||= ENV["DATABASE_URL"] if spec_name == "primary"
  url
end
merge_db_environment_variables(current_env, configs) click to toggle source
# File lib/active_record/database_configurations.rb, line 177
def merge_db_environment_variables(current_env, configs)
  configs.map do |config|
    next config if config.url_config? || config.env_name != current_env

    url_config = environment_url_config(current_env, config.spec_name, config.config)
    url_config || config
  end
end
method_missing(method, *args, &blk) click to toggle source
# File lib/active_record/database_configurations.rb, line 200
def method_missing(method, *args, &blk)
  case method
  when :fetch
    throw_getter_deprecation(method)
    configs_for(env_name: args.first)
  when :values
    throw_getter_deprecation(method)
    configurations.map(&:config)
  when :[]=
    throw_setter_deprecation(method)

    env_name = args[0]
    config = args[1]

    remaining_configs = configurations.reject { |db_config| db_config.env_name == env_name }
    new_config = build_configs(env_name => config)
    new_configs = remaining_configs + new_config

    ActiveRecord::Base.configurations = new_configs
  else
    raise NotImplementedError, "`ActiveRecord::Base.configurations` in Rails 6 now returns an object instead of a hash. The `#{method}` method is not supported. Please use `configs_for` or consult the documentation for supported methods."
  end
end
throw_getter_deprecation(method) click to toggle source
# File lib/active_record/database_configurations.rb, line 228
def throw_getter_deprecation(method)
  ActiveSupport::Deprecation.warn("`ActiveRecord::Base.configurations` no longer returns a hash. Methods that act on the hash like `#{method}` are deprecated and will be removed in Rails 6.1. Use the `configs_for` method to collect and iterate over the database configurations.")
end
throw_setter_deprecation(method) click to toggle source
# File lib/active_record/database_configurations.rb, line 224
def throw_setter_deprecation(method)
  ActiveSupport::Deprecation.warn("Setting `ActiveRecord::Base.configurations` with `#{method}` is deprecated. Use `ActiveRecord::Base.configurations=` directly to set the configurations instead.")
end
walk_configs(env_name, config) click to toggle source
# File lib/active_record/database_configurations.rb, line 138
def walk_configs(env_name, config)
  config.map do |spec_name, sub_config|
    build_db_config_from_raw_config(env_name, spec_name.to_s, sub_config)
  end
end