class ActiveRecord::DatabaseConfigurations::UrlConfig

Active Record Database Url Config

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">

See ActiveRecord::DatabaseConfigurations for more info.

Attributes

url[R]

Public Class Methods

new(env_name, name, url, configuration_hash = {}) click to toggle source

Initialize a new UrlConfig object

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.

# File lib/active_record/database_configurations/url_config.rb, line 40
def initialize(env_name, name, url, configuration_hash = {})
  super(env_name, name, configuration_hash)

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

  if @configuration_hash[:schema_dump] == "false"
    @configuration_hash[:schema_dump] = false
  end

  if @configuration_hash[:query_cache] == "false"
    @configuration_hash[:query_cache] = false
  end

  to_boolean!(@configuration_hash, :replica)
  to_boolean!(@configuration_hash, :database_tasks)

  @configuration_hash.freeze
end

Private Instance Methods

build_url_hash() click to toggle source

Return a Hash that can be merged into the main config that represents the passed in url

# File lib/active_record/database_configurations/url_config.rb, line 69
def build_url_hash
  if url.nil? || url.start_with?("jdbc:", "http:", "https:")
    { url: url }
  else
    ConnectionUrlResolver.new(url).to_hash
  end
end
to_boolean!(configuration_hash, key) click to toggle source
# File lib/active_record/database_configurations/url_config.rb, line 61
def to_boolean!(configuration_hash, key)
  if configuration_hash[key].is_a?(String)
    configuration_hash[key] = configuration_hash[key] != "false"
  end
end