Class: ActiveRecord::DatabaseConfigurations

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/database_configurations.rb,
lib/active_record/database_configurations/url_config.rb,
lib/active_record/database_configurations/hash_config.rb,
lib/active_record/database_configurations/database_config.rb,
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

Instance Method Summary collapse

Constructor Details

#initialize(configurations = {}) ⇒ DatabaseConfigurations

Returns a new instance of DatabaseConfigurations.



19
20
21
 
# File 'lib/active_record/database_configurations.rb', line 19

def initialize(configurations = {})
  @configurations = build_configs(configurations)
end

Instance Attribute Details

#configurations ⇒ Object (readonly)

Returns the value of attribute configurations.



16
17
18
 
# File 'lib/active_record/database_configurations.rb', line 16

def configurations
  @configurations
end

Instance Method Details

#configs_for(env_name: nil, spec_name: nil, 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 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.

  • name: The db config name (i.e. primary, animals, etc.). Defaults to nil. If no env_name is specified the config for the default env and the passed 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 to false.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# 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

#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" }



71
72
73
74
 
# 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

#empty? ⇒ Boolean Also known as: blank?

Checks if the application's configurations are empty.

Aliased to blank?

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/active_record/database_configurations.rb', line 115

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.



82
83
84
85
86
87
88
89
 
# 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

#primary?(name) ⇒ Boolean

A primary configuration is one that is named primary or if there is no primary, the first configuration for an environment will be treated as primary. This is used as the “default” configuration and is used when the application needs to treat one configuration differently. For example, when Rails dumps the schema, the primary configuration's schema file will be named `schema.rb` instead of `primary_schema.rb`.

Returns:

  • (Boolean) 


97
98
99
100
101
102
 
# File 'lib/active_record/database_configurations.rb', line 97

def primary?(name) # :nodoc:
  return true if name == "primary"

  first_config = find_db_config(default_env)
  first_config && name == first_config.name
end

#resolve(config) ⇒ 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"})



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/active_record/database_configurations.rb', line 139

def resolve(config) # :nodoc:
  return config if DatabaseConfigurations::DatabaseConfig === config

  case config
  when Symbol
    resolve_symbol_connection(config)
  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.



105
106
107
108
109
 
# 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