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.

Namespace

Class

Methods

Attributes

[R] configurations

Class Public methods

new(configurations = {})

# File activerecord/lib/active_record/database_configurations.rb, line 18
def initialize(configurations = {})
  @configurations = build_configs(configurations)
end

Instance Public methods

[](env = default_env)

Alias for: default_hash

blank?()

Alias for: empty?

configs_for(env_name: nil, spec_name: nil, name: nil, include_replicas: false, include_hidden: false)

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

If a 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.

  • name: The db config name (i.e. primary, animals, etc.). Defaults to nil. If no env_name is specified the config for the default env and the passed name will be returned.

  • include_replicas: Deprecated. 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.

  • <tt>include_hidden:</tte Determines whether to include replicas and configurations hidden by +database_tasks: false+ in the returned list. Most of the time we're only iterating over the primary connections (i.e. migrations don't need to run for the write and read connection). Defaults to false.

# File activerecord/lib/active_record/database_configurations.rb, line 44
def configs_for(env_name: nil, spec_name: nil, name: nil, include_replicas: false, include_hidden: false)
  if spec_name
    name = spec_name
    ActiveSupport::Deprecation.warn("The kwarg `spec_name` is deprecated in favor of `name`. `spec_name` will be removed in Rails 7.0")
  end

  if include_replicas
    include_hidden = include_replicas
    ActiveSupport::Deprecation.warn("The kwarg `include_replicas` is deprecated in favor of `include_hidden`. When `include_hidden` is passed, configurations with `replica: true` or `database_tasks: false` will be returned. `include_replicas` will be removed in Rails 7.1.")
  end

  env_name ||= default_env if name
  configs = env_with_configs(env_name)

  unless include_hidden
    configs = configs.select do |db_config|
      db_config.database_tasks?
    end
  end

  if name
    configs.find do |db_config|
      db_config.name == name
    end
  else
    configs
  end
end

default_hash(env = default_env)

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" }
Also aliased as: []
# File activerecord/lib/active_record/database_configurations.rb, line 79
def default_hash(env = default_env)
  default = find_db_config(env)
  default.configuration_hash if default
end

empty?()

Checks if the application's configurations are empty.

Aliased to blank?

Also aliased as: blank?
# File activerecord/lib/active_record/database_configurations.rb, line 123
def empty?
  configurations.empty?
end

find_db_config(env)

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 activerecord/lib/active_record/database_configurations.rb, line 90
def find_db_config(env)
  configurations
    .sort_by.with_index { |db_config, i| db_config.for_current_env? ? [0, i] : [1, i] }
    .find do |db_config|
      db_config.env_name == env.to_s ||
        (db_config.for_current_env? && db_config.name == env.to_s)
    end
end

to_h()

Returns the DatabaseConfigurations object as a Hash.

# File activerecord/lib/active_record/database_configurations.rb, line 113
def to_h
  configurations.inject({}) do |memo, db_config|
    memo.merge(db_config.env_name => db_config.configuration_hash.stringify_keys)
  end
end