Class: ActiveRecord::DatabaseConfigurations::HashConfig

Inherits:
DatabaseConfig
  • Object
show all
Defined in:
lib/active_record/database_configurations/hash_config.rb

Overview

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.

Instance Attribute Summary collapse

Attributes inherited from DatabaseConfig

#env_name, #spec_name

Instance Method Summary collapse

Methods inherited from DatabaseConfig

#for_current_env?, #to_legacy_hash, #url_config?

Constructor Details

#initialize(env_name, spec_name, config) ⇒ HashConfig

Returns a new instance of HashConfig.



30
31
32
33
 
# File '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

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



28
29
30
 
# File 'lib/active_record/database_configurations/hash_config.rb', line 28

def config
  @config
end

Instance Method Details

#migrations_paths ⇒ Object

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



45
46
47
 
# File 'lib/active_record/database_configurations/hash_config.rb', line 45

def migrations_paths
  config["migrations_paths"]
end

#replica? ⇒ Boolean

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

Returns:

  • (Boolean) 


38
39
40
 
# File 'lib/active_record/database_configurations/hash_config.rb', line 38

def replica?
  config["replica"]
end