A HashConfig object is created for each database configuration entry that is created from a hash.

A hash config:

{ "development" => { "database" => "db_name" } }

Becomes:

#<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10
  @env_name="development", @name="primary", @config={database: "db_name"}>

Options

  • :env_name - The Rails environment, i.e. “development”.

  • :name - The db config name. In a standard two-tier database configuration this will default to “primary”. In a multiple database three-tier database configuration this corresponds to the name used in the second tier, for example “primary_readonly”.

  • :config - The config hash. This is the hash that contains the database adapter, name, and other important information for database connections.

Methods

Attributes

[R] configuration_hash

Class Public methods

new(env_name, name, configuration_hash)

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 30
def initialize(env_name, name, configuration_hash)
  super(env_name, name)
  @configuration_hash = configuration_hash.symbolize_keys.freeze
end

Instance Public methods

adapter()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 101
def adapter
  configuration_hash[:adapter]
end

checkout_timeout()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 86
def checkout_timeout
  (configuration_hash[:checkout_timeout] || 5).to_f
end

config()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 35
def config
  ActiveSupport::Deprecation.warn("DatabaseConfig#config will be removed in 7.0.0 in favor of DatabaseConfigurations#configuration_hash which returns a hash with symbol keys")
  configuration_hash.stringify_keys
end

database()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 62
def database
  configuration_hash[:database]
end

host()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 54
def host
  configuration_hash[:host]
end

idle_timeout()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 96
def idle_timeout
  timeout = configuration_hash.fetch(:idle_timeout, 300).to_f
  timeout if timeout > 0
end

max_queue()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 82
def max_queue
  max_threads * 4
end

max_threads()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 78
def max_threads
  (configuration_hash[:max_threads] || pool).to_i
end

migrations_paths()

The migrations paths for a database configuration. If the migrations_paths key is present in the config, migrations_paths will return its value.

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 50
def migrations_paths
  configuration_hash[:migrations_paths]
end

min_threads()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 74
def min_threads
  (configuration_hash[:min_threads] || 0).to_i
end

pool()

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 70
def pool
  (configuration_hash[:pool] || 5).to_i
end

reaping_frequency()

reaping_frequency is configurable mostly for historical reasons, but it could also be useful if someone wants a very low idle_timeout.

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 92
def reaping_frequency
  configuration_hash.fetch(:reaping_frequency, 60)&.to_f
end

replica?()

Determines whether a database configuration is for a replica / readonly connection. If the replica key is present in the config, replica? will return true.

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 43
def replica?
  configuration_hash[:replica]
end

schema_cache_path()

The path to the schema cache dump file for a database. If omitted, the filename will be read from ENV or a default will be derived.

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 108
def schema_cache_path
  configuration_hash[:schema_cache_path]
end

schema_dump()

Determines whether to dump the schema for a database.

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 113
def schema_dump
  configuration_hash.fetch(:schema_dump, true)
end