instance method `configs_for`

Ruby on Rails 6.0.6

Since v6.0.6

Available in: v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

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.

Parameters

env_name key = nil
spec_name key = nil
include_replicas key = false

Source

# 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

Defined in activerecord/lib/active_record/database_configurations.rb line 38 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveRecord::DatabaseConfigurations

Signature

Options

Parameters