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 19
    def initialize(configurations = {})
      @configurations = build_configs(configurations)
    end
🔎 See on GitHub

Instance Public methods

blank?()

Alias for: empty?

configs_for(env_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.

  • include_hidden: 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.

📝 Source code 
# File activerecord/lib/active_record/database_configurations.rb, line 45
    def configs_for(env_name: nil, name: nil, include_replicas: false, include_hidden: false)
      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
🔎 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 98
    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 73
    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
🔎 See on GitHub