Class: ActiveRecord::DatabaseConfigurations
- Defined in:
- activerecord/lib/active_record/database_configurations.rb,
activerecord/lib/active_record/database_configurations/url_config.rb,
activerecord/lib/active_record/database_configurations/hash_config.rb,
activerecord/lib/active_record/database_configurations/database_config.rb,
activerecord/lib/active_record/database_configurations/connection_url_resolver.rb
Overview
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.
Defined Under Namespace
Classes: ConnectionUrlResolver, DatabaseConfig, HashConfig, InvalidConfigurationError, UrlConfig
Instance Attribute Summary collapse
-
#configurations ⇒ Object
readonly
Returns the value of attribute configurations.
Instance Method Summary collapse
-
#configs_for(env_name: nil, spec_name: nil, include_replicas: false) ⇒ Object
Collects the configs for the environment and optionally the specification name passed in.
-
#default_hash(env = default_env) ⇒ Object
(also: #[])
Returns the config hash that corresponds with the environment.
- #each ⇒ Object
-
#empty? ⇒ Boolean
(also: #blank?)
Checks if the application’s configurations are empty.
-
#find_db_config(env) ⇒ Object
Returns a single DatabaseConfig object based on the requested environment.
- #first ⇒ Object
-
#initialize(configurations = {}) ⇒ DatabaseConfigurations
constructor
A new instance of DatabaseConfigurations.
-
#resolve(config, pool_name = nil) ⇒ Object
Returns fully resolved connection, accepts hash, string or symbol.
-
#to_h ⇒ Object
Returns the DatabaseConfigurations object as a Hash.
Constructor Details
#initialize(configurations = {}) ⇒ DatabaseConfigurations
Returns a new instance of DatabaseConfigurations.
18 19 20 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 18 def initialize(configurations = {}) @configurations = build_configs(configurations) end |
Dynamic Method Handling
This class handles dynamic methods through the method_missing method
#method_missing(method, *args, &blk) ⇒ Object (private)
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 269 def method_missing(method, *args, &blk) case method when :fetch throw_getter_deprecation(method) configs_for(env_name: args.first) when :values throw_getter_deprecation(method) configurations.map(&:configuration_hash) when :[]= throw_setter_deprecation(method) env_name = args[0] config = args[1] remaining_configs = configurations.reject { |db_config| db_config.env_name == env_name } new_config = build_configs(env_name => config) new_configs = remaining_configs + new_config ActiveRecord::Base.configurations = new_configs else raise NotImplementedError, "`ActiveRecord::Base.configurations` in Rails 6 now returns an object instead of a hash. The `#{method}` method is not supported. Please use `configs_for` or consult the documentation for supported methods." end end |
Instance Attribute Details
#configurations ⇒ Object (readonly)
Returns the value of attribute configurations
15 16 17 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 15 def configurations @configurations end |
Instance Method Details
#configs_for(env_name: nil, spec_name: nil, include_replicas: false) ⇒ Object
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
. If noenv_name
is specified the config for the default env and the passedspec_name
will be returned. -
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
.
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 40 def configs_for(env_name: nil, spec_name: nil, include_replicas: false) env_name ||= default_env if spec_name 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 |
#default_hash(env = default_env) ⇒ Object Also known as: []
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" }
65 66 67 68 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 65 def default_hash(env = default_env) default = find_db_config(env) default.configuration_hash if default end |
#each ⇒ Object
98 99 100 101 102 103 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 98 def each throw_getter_deprecation(:each) configurations.each { |config| yield [config.env_name, config.configuration_hash] } end |
#empty? ⇒ Boolean Also known as: blank?
Checks if the application’s configurations are empty.
Aliased to blank?
93 94 95 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 93 def empty? configurations.empty? end |
#find_db_config(env) ⇒ Object
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.
75 76 77 78 79 80 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 75 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 |
#first ⇒ Object
105 106 107 108 109 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 105 def first throw_getter_deprecation(:first) config = configurations.first [config.env_name, config.configuration_hash] end |
#resolve(config, pool_name = nil) ⇒ Object
Returns fully resolved connection, accepts hash, string or symbol. Always returns a DatabaseConfiguration::DatabaseConfig
Examples
Symbol representing current environment.
DatabaseConfigurations.new("production" => {}).resolve(:production)
# => DatabaseConfigurations::HashConfig.new(env_name: "production", config: {})
One layer deep hash of connection values.
DatabaseConfigurations.new({}).resolve("adapter" => "sqlite3")
# => DatabaseConfigurations::HashConfig.new(config: {"adapter" => "sqlite3"})
Connection URL.
DatabaseConfigurations.new({}).resolve("postgresql://localhost/foo")
# => DatabaseConfigurations::UrlConfig.new(config: {"adapter" => "postgresql", "host" => "localhost", "database" => "foo"})
130 131 132 133 134 135 136 137 138 139 140 141 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 130 def resolve(config, pool_name = nil) # :nodoc: return config if DatabaseConfigurations::DatabaseConfig === config case config when Symbol resolve_symbol_connection(config, pool_name) when Hash, String build_db_config_from_raw_config(default_env, "primary", config) else raise TypeError, "Invalid type for configuration. Expected Symbol, String, or Hash. Got #{config.inspect}" end end |
#to_h ⇒ Object
Returns the DatabaseConfigurations object as a Hash.
83 84 85 86 87 |
# File 'activerecord/lib/active_record/database_configurations.rb', line 83 def to_h configurations.inject({}) do |memo, db_config| memo.merge(db_config.env_name => db_config.configuration_hash.stringify_keys) end end |