Class: ActiveRecord::DatabaseConfigurations::UrlConfig

Inherits:
HashConfig show all
Defined in:
activerecord/lib/active_record/database_configurations/url_config.rb

Overview

A UrlConfig object is created for each database configuration entry that is created from a URL. This can either be a URL string or a hash with a URL in place of the config hash.

A URL config:

postgres://localhost/foo

Becomes:

#<ActiveRecord::DatabaseConfigurations::UrlConfig:0x00007fdc3238f340
  @env_name="default_env", @name="primary",
  @config={adapter: "postgresql", database: "foo", host: "localhost"},
  @url="postgres://localhost/foo">

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”.

  • :url - The database URL.

  • :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 HashConfig

#configuration_hash

Attributes inherited from DatabaseConfig

#env_name, #name

Instance Method Summary collapse

Methods inherited from HashConfig

#_database=, #adapter, #checkout_timeout, #database, #database_tasks?, #default_schema_cache_path, #host, #idle_timeout, #lazy_schema_cache_path, #max_queue, #max_threads, #migrations_paths, #min_threads, #pool, #primary?, #reaping_frequency, #replica?, #schema_cache_path, #schema_dump, #socket

Methods inherited from DatabaseConfig

#_database=, #adapter, #adapter_class_method, #adapter_method, #checkout_timeout, #database, #for_current_env?, #host, #idle_timeout, #max_queue, #max_threads, #migrations_paths, #min_threads, #pool, #reaping_frequency, #replica?, #schema_cache_path

Constructor Details

#initialize(env_name, name, url, configuration_hash = {}) ⇒ UrlConfig

Returns a new instance of UrlConfig.



34
35
36
37
38
39
 
# File 'activerecord/lib/active_record/database_configurations/url_config.rb', line 34

def initialize(env_name, name, url, configuration_hash = {})
  super(env_name, name, configuration_hash)

  @url = url
  @configuration_hash = @configuration_hash.merge(build_url_hash).freeze
end

Instance Attribute Details

#url ⇒ Object (readonly)

Returns the value of attribute url



32
33
34
 
# File 'activerecord/lib/active_record/database_configurations/url_config.rb', line 32

def url
  @url
end