123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::DatabaseConfigurations::UrlConfig

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, HashConfig
Instance Chain:
self, HashConfig
Inherits: ActiveRecord::DatabaseConfigurations::HashConfig
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, ie “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.

Class Method Summary

HashConfig - Inherited

.new

Instance Attribute Summary

HashConfig - Inherited

#configuration_hash,
#replica?

Determines whether a database configuration is for a replica / readonly connection.

Instance Method Summary

HashConfig - Inherited

#adapter, #checkout_timeout, #config, #database, #host, #idle_timeout,
#migrations_paths

The migrations paths for a database configuration.
#pool,
#reaping_frequency

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

The path to the schema cache dump file for a database.

Constructor Details

.new(env_name, name, url, configuration_hash = {}) ⇒ UrlConfig

[ GitHub ] 

  


# 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   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :url