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
- D
- E
- F
- N
- T
[R] | configurations |
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 tonil
which will collect configs for all environments. -
spec_name:
The specification name (i.e. primary, animals, etc.). Defaults tonil
. -
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 tofalse
.
# 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
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" }
Checks if the application's configurations are empty.
Aliased to blank?
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.
Returns the DatabaseConfigurations
object as a Hash
.