123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::DatabaseConfigurations::UrlConfig

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, HashConfig, DatabaseConfig
Instance Chain:
self, HashConfig, DatabaseConfig
Inherits: ActiveRecord::DatabaseConfigurations::HashConfig
Defined in: activerecord/lib/active_record/database_configurations/url_config.rb

Overview

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.

Class Method Summary

HashConfig - Inherited

.new

Initialize a new HashConfig object.

DatabaseConfig - Inherited

.new

Instance Attribute Summary

HashConfig - Inherited

#configuration_hash,
#replica?

Determines whether a database configuration is for a replica / readonly connection.
#_database=, #database_tasks?, #primary?, #use_metadata_table?

DatabaseConfig - Inherited

#_database=, #env_name, #for_current_env?, #name, #replica?, #use_metadata_table?

Instance Method Summary

HashConfig - Inherited

#adapter, #checkout_timeout, #database, #default_schema_cache_path, #host, #idle_timeout, #lazy_schema_cache_path, #max_queue, #max_threads,
#migrations_paths

The migrations paths for a database configuration.
#min_threads, #pool, #query_cache,
#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.
#schema_dump

Determines whether to dump the schema/structure files and the filename that should be used.
#schema_file_type, #socket

DatabaseConfig - Inherited

#adapter, #adapter_class, #checkout_timeout, #database, #host, #idle_timeout, #max_queue, #max_threads, #migrations_paths, #min_threads, #new_connection, #pool, #query_cache, #reaping_frequency, #schema_cache_path, #validate!

Constructor Details

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

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.

[ GitHub ] 

  


# File 'activerecord/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


  







Instance Attribute Details



  

    #url   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :url


  







Instance Method Details



  

    #build_url_hash   (private)
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activerecord/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)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/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