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

class ActiveRecord::DatabaseConfigurations::UrlConfig

Parent:
ActiveRecord::DatabaseConfigurations::DatabaseConfig

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", @spec_name="primary",
  @config={"adapter"=>"postgresql", "database"=>"foo", "host"=>"localhost"},
  @url="postgres://localhost/foo">

Options

  • :env_name - The Rails environment, ie “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”.

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

Attributes

config[R]
url[R]

Public Class Methods

new(env_name, spec_name, url, config = {}) Show source 
# File activerecord/lib/active_record/database_configurations/url_config.rb, line 34
def initialize(env_name, spec_name, url, config = {})
  super(env_name, spec_name)
  @config = build_config(config, url)
  @url = url
end
Calls superclass method

Public Instance Methods

migrations_paths() Show source 
# File activerecord/lib/active_record/database_configurations/url_config.rb, line 54
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/url_config.rb, line 47
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.