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 = {})

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 17
    def initialize(configurations = {})
      @configurations = build_configs(configurations)
    end
🔎 See on GitHub

Instance Public 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)

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.

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 38
    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
🔎 See on GitHub

default_hash(env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s)

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: []
📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 62
    def default_hash(env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s)
      default = find_db_config(env)
      default.config if default
    end
🔎 See on GitHub

each()

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 96
    def each
      throw_getter_deprecation(:each)
      configurations.each { |config|
        yield [config.env_name, config.config]
      }
    end
🔎 See on GitHub

empty?()

Checks if the application's configurations are empty.

Aliased to blank?

Also aliased as: blank?
📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 91
    def empty?
      configurations.empty?
    end
🔎 See on GitHub

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.

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 72
    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
🔎 See on GitHub

first()

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 103
    def first
      throw_getter_deprecation(:first)
      config = configurations.first
      [config.env_name, config.config]
    end
🔎 See on GitHub

to_h()

Returns the DatabaseConfigurations object as a Hash.

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 80
    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
🔎 See on GitHub