class ActiveRecord::DatabaseConfigurations
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.
Attributes
Public Class Methods
# File lib/active_record/database_configurations.rb, line 19 def initialize(configurations = {}) @configurations = build_configs(configurations) end
Public Instance Methods
Collects the configs for the environment and optionally the specification name passed in. To include replica configurations pass include_replicas: 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:
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 lib/active_record/database_configurations.rb, line 41 def configs_for(env_name: nil, spec_name: nil, name: nil, include_replicas: false) if spec_name name = spec_name ActiveSupport::Deprecation.warn("The kwarg `spec_name` is deprecated in favor of `name`. `spec_name` will be removed in Rails 7.0") end env_name ||= default_env if name configs = env_with_configs(env_name) unless include_replicas configs = configs.select do |db_config| !db_config.replica? end end if name configs.find do |db_config| db_config.name == 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" }
# File lib/active_record/database_configurations.rb, line 71 def default_hash(env = default_env) default = find_db_config(env) default.configuration_hash if default end
Checks if the application's configurations are empty.
Aliased to blank?
# File lib/active_record/database_configurations.rb, line 115 def empty? configurations.empty? end
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 lib/active_record/database_configurations.rb, line 82 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
Returns the DatabaseConfigurations
object as a Hash.
# File lib/active_record/database_configurations.rb, line 105 def to_h configurations.inject({}) do |memo, db_config| memo.merge(db_config.env_name => db_config.configuration_hash.stringify_keys) end end
Private Instance Methods
# File lib/active_record/database_configurations.rb, line 165 def build_configs(configs) return configs.configurations if configs.is_a?(DatabaseConfigurations) return configs if configs.is_a?(Array) db_configs = configs.flat_map do |env_name, config| if config.is_a?(Hash) && config.all? { |_, v| v.is_a?(Hash) } walk_configs(env_name.to_s, config) else build_db_config_from_raw_config(env_name.to_s, "primary", config) end end unless db_configs.find(&:for_current_env?) db_configs << environment_url_config(default_env, "primary", {}) end merge_db_environment_variables(default_env, db_configs.compact) end
# File lib/active_record/database_configurations.rb, line 204 def build_configuration_sentence configs = configs_for(include_replicas: true) configs.group_by(&:env_name).map do |env, config| names = config.map(&:name) if names.size > 1 "#{env}: #{names.join(", ")}" else env end end.join("\n") end
# File lib/active_record/database_configurations.rb, line 238 def build_db_config_from_hash(env_name, name, config) if config.has_key?(:url) url = config[:url] config_without_url = config.dup config_without_url.delete :url UrlConfig.new(env_name, name, url, config_without_url) else HashConfig.new(env_name, name, config) end end
# File lib/active_record/database_configurations.rb, line 217 def build_db_config_from_raw_config(env_name, name, config) case config when String build_db_config_from_string(env_name, name, config) when Hash build_db_config_from_hash(env_name, name, config.symbolize_keys) else raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash." end end
# File lib/active_record/database_configurations.rb, line 228 def build_db_config_from_string(env_name, name, config) url = config uri = URI.parse(url) if uri.scheme UrlConfig.new(env_name, name, url) else raise InvalidConfigurationError, "'{ #{env_name} => #{config} }' is not a valid configuration. Expected '#{config}' to be a URL string or a Hash." end end
# File lib/active_record/database_configurations.rb, line 153 def default_env ActiveRecord::ConnectionHandling::DEFAULT_ENV.call.to_s end
# File lib/active_record/database_configurations.rb, line 157 def env_with_configs(env = nil) if env configurations.select { |db_config| db_config.env_name == env } else configurations end end
# File lib/active_record/database_configurations.rb, line 259 def environment_url_config(env, name, config) url = environment_value_for(name) return unless url UrlConfig.new(env, name, url, config) end
# File lib/active_record/database_configurations.rb, line 266 def environment_value_for(name) name_env_key = "#{name.upcase}_DATABASE_URL" url = ENV[name_env_key] url ||= ENV["DATABASE_URL"] if name == "primary" url end
# File lib/active_record/database_configurations.rb, line 250 def merge_db_environment_variables(current_env, configs) configs.map do |config| next config if config.is_a?(UrlConfig) || config.env_name != current_env url_config = environment_url_config(current_env, config.name, config.configuration_hash) url_config || config end end
# File lib/active_record/database_configurations.rb, line 190 def resolve_symbol_connection(name) if db_config = find_db_config(name) db_config else raise AdapterNotSpecified, <<~MSG The `#{name}` database is not configured for the `#{default_env}` environment. Available databases configurations are: #{build_configuration_sentence} MSG end end
# File lib/active_record/database_configurations.rb, line 184 def walk_configs(env_name, config) config.map do |name, sub_config| build_db_config_from_raw_config(env_name, name.to_s, sub_config) end end