class `ActiveRecord::DatabaseConfigurations::HashConfig`

Active Record Database Hash Config

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

See ActiveRecord::DatabaseConfigurations for more info.

Inherits From

class ActiveRecord::DatabaseConfigurations::DatabaseConfig

Attributes

[R] configuration_hash

Public class methods

`new(env_name, name, configuration_hash)`

Initialize a new HashConfig object

Parameters

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”.
configuration_hash - The config hash. This is the hash that contains the database adapter, name, and other important information for database connections.

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 38
      def initialize(env_name, name, configuration_hash)
        super(env_name, name)
        @configuration_hash = configuration_hash.symbolize_keys.freeze
        ActiveRecord.deprecator.warn(<<~MSG) if @configuration_hash[:pool]
          The pool option is deprecated and will be removed in Rails 8.2. Use max_connections instead.
        MSG
      end

Public instance methods

`adapter()`

Source code GitHub

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

`checkout_timeout()`

Source code GitHub

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

`database()`

Source code GitHub

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

`default_schema_cache_path(db_dir = "db")`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 139
def default_schema_cache_path(db_dir = "db")
  if primary?
    File.join(db_dir, "schema_cache.yml")
  else
    File.join(db_dir, "#{name}_schema_cache.yml")
  end
end

`host()`

Source code GitHub

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

`idle_timeout()`

Source code GitHub

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

`keepalive()`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 124
def keepalive
  keepalive = (configuration_hash[:keepalive] || 600).to_f
  keepalive if keepalive > 0
end

`lazy_schema_cache_path()`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 147
def lazy_schema_cache_path
  schema_cache_path || default_schema_cache_path
end

`max_age()`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 94
def max_age
  v = configuration_hash[:max_age]&.to_i
  if v && v > 0
    v
  else
    Float::INFINITY
  end
end

`max_connections()`

Also aliased as: pool.

Source code GitHub

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

`max_queue()`

Source code GitHub

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

`max_threads()`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 90
def max_threads
  (configuration_hash[:max_threads] || max_connections).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.

Source code GitHub

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

`min_connections()`

Source code GitHub

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

`min_threads()`

Source code GitHub

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

`pool()`

Alias for: max_connections.

`query_cache()`

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 103
def query_cache
  configuration_hash[:query_cache]
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.

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 49
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.

Source code GitHub

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

`schema_dump(format = ActiveRecord.schema_format)`

Determines whether to dump the schema/structure files and the filename that should be used.

If configuration_hash[:schema_dump] is set to false or nil the schema will not be dumped.

If the config option is set that will be used. Otherwise Rails will generate the filename from the database config name.

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 171
def schema_dump(format = ActiveRecord.schema_format)
  if configuration_hash.key?(:schema_dump)
    if config = configuration_hash[:schema_dump]
      config
    end
  elsif primary?
    schema_file_type(format)
  else
    "#{name}_#{schema_file_type(format)}"
  end
end

`seeds?()`

Determines whether the db:prepare task should seed the database from db/seeds.rb.

If the seeds key is present in the config, seeds? will return its value. Otherwise, it will return true for the primary database and false for all other configs.

Source code GitHub

# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 159
def seeds?
  configuration_hash.fetch(:seeds, primary?)
end

Definition files

activerecord/lib/active_record/database_configurations/hash_config.rb

class ActiveRecord::DatabaseConfigurations::HashConfig

Inherits From

Attributes

Public class methods

new(env_name, name, configuration_hash)

Parameters

Public instance methods

adapter()

checkout_timeout()

database()

default_schema_cache_path(db_dir = "db")

host()

idle_timeout()

keepalive()

lazy_schema_cache_path()

max_age()

max_connections()

max_queue()

max_threads()

migrations_paths()

min_connections()

min_threads()

pool()

query_cache()

replica?()

schema_cache_path()

schema_dump(format = ActiveRecord.schema_format)

seeds?()

Definition files

class `ActiveRecord::DatabaseConfigurations::HashConfig`

`new(env_name, name, configuration_hash)`

`adapter()`

`checkout_timeout()`

`database()`

`default_schema_cache_path(db_dir = "db")`

`host()`

`idle_timeout()`

`keepalive()`

`lazy_schema_cache_path()`

`max_age()`

`max_connections()`

`max_queue()`

`max_threads()`

`migrations_paths()`

`min_connections()`

`min_threads()`

`pool()`

`query_cache()`

`replica?()`

`schema_cache_path()`

`schema_dump(format = ActiveRecord.schema_format)`

`seeds?()`