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.
- CLASS ActiveRecord::DatabaseConfigurations::HashConfig
- CLASS ActiveRecord::DatabaseConfigurations::InvalidConfigurationError
- CLASS ActiveRecord::DatabaseConfigurations::UrlConfig
- B
- C
- E
- F
- N
Attributes
[R] | configurations |
Class Public methods
new(configurations = {}) Link
Instance Public methods
configs_for(env_name: nil, name: nil, include_replicas: false, include_hidden: false) Link
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 tonil
which will collect configs for all environments. -
name:
The db config name (i.e. primary, animals, etc.). Defaults tonil
. If noenv_name
is specified the config for the default env and the passedname
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 tofalse
. -
<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 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
empty?() Link
Checks if the application's configurations are empty.
Aliased to blank?
find_db_config(env) Link
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 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