Docs4dev
Docs
rails / 6.0 / activerecord / databaseconfigurations / hashconfig.html

class ActiveRecord::DatabaseConfigurations::HashConfig

Parent:
ActiveRecord::DatabaseConfigurations::DatabaseConfig

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", @spec_name="primary", @config={"database"=>"db_name"}>

Options

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

  • :spec_name - The specification 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.

Attributes

config[R]

Public Class Methods

new(env_name, spec_name, config) Show source 
# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 30
def initialize(env_name, spec_name, config)
  super(env_name, spec_name)
  @config = config
end
Calls superclass method

Public Instance Methods

migrations_paths() Show source 
# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 45
def migrations_paths
  config["migrations_paths"]
end

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

replica?() Show source 
# File activerecord/lib/active_record/database_configurations/hash_config.rb, line 38
def replica?
  config["replica"]
end

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

© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.