123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::DatabaseConfigurations::HashConfig

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

Overview

Active Record Database Hash Config

A HashConfig object is created for each database configuration entry that is created from a hash.

A hash config:

{ "development" => { "database" => "db_name" } }

Becomes:

#<ActiveRecord::DatabaseConfigurations::HashConfig:0x00007fd1acbded10
  @env_name="development", @name="primary", @config={database: "db_name"}>

See ::ActiveRecord::DatabaseConfigurations for more info.

Class Method Summary

DatabaseConfig - Inherited

.new

Instance Attribute Summary

DatabaseConfig - Inherited

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

Instance Method Summary

DatabaseConfig - Inherited

#adapter, #adapter_class, #checkout_timeout, #comparable_values, #database, #freeze, #host, #idle_timeout, #inspect, #max_connections, #max_queue, #max_threads, #migrations_paths, #min_connections, #min_threads, #new_connection, #query_cache, #reaping_frequency, #schema_cache_path, #validate!

Constructor Details

.new(env_name, name, configuration_hash) ⇒ HashConfig

Initialize a new HashConfig object

Parameters

  • 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".
  • #configuration_hash - 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/hash_config.rb', line 36



def initialize(env_name, name, configuration_hash)
  super(env_name, name)
  @configuration_hash = configuration_hash.symbolize_keys.freeze
  validate_configuration!
  query_log_tags = @configuration_hash[:query_log_tags]
  @query_log_tags_format = (query_log_tags["format"]&.to_sym if query_log_tags.is_a?(Hash))
  @query_log_tags_prepend_comment = (query_log_tags["prepend_comment"] if query_log_tags.is_a?(Hash))
end


  







Instance Attribute Details



  

    #_database=(database)   (writeonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 83



def _database=(database) # :nodoc:
  @configuration_hash = configuration_hash.merge(database: database).freeze
end


  








  

    #configuration_hash   (readonly)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 21



attr_reader :configuration_hash


  








  

    #database_tasks?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 231



def database_tasks? # :nodoc:
  !replica? && !!configuration_hash.fetch(:database_tasks, true)
end


  








  

    #dump_schema_migrations?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 239



def dump_schema_migrations? # :nodoc:
  configuration_hash.fetch(:dump_schema_migrations, ActiveRecord.dump_schema_migrations)
end


  








  

    #primary?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 193



def primary? # :nodoc:
  Base.configurations.primary?(name)
end


  








  

    #query_log_tags_format   (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 127



attr_reader :query_log_tags_format, :query_log_tags_prepend_comment # :nodoc:


  








  

    #query_log_tags_prepend_comment   (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 127



attr_reader :query_log_tags_format, :query_log_tags_prepend_comment # :nodoc:


  








  

    #replica?  ⇒ Boolean  (readonly)
  



  

    
Determines whether a database configuration is for a replica / readonly
connection. If the replica key is present in the config, replica? will
return true.

  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 61



def replica?
  configuration_hash[:replica]
end


  








  

    #seeds?  ⇒ Boolean  (readonly)
  



  

    
Determines whether the db:prepare task should seed the database from db/seeds.rb.


If the seeds key is present in the config, seeds? will return its value.  Otherwise, it
will return true for the primary database and false for all other configs.

  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 201



def seeds?
  configuration_hash.fetch(:seeds, primary?)
end


  








  

    #use_metadata_table?  ⇒ Boolean  (readonly)
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 235



def use_metadata_table? # :nodoc:
  configuration_hash.fetch(:use_metadata_table, true)
end


  







Instance Method Details



  

    #==(other)  
    Also known as: #eql?
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 45



def ==(other)
  other.is_a?(DatabaseConfig) && comparable_values == other.comparable_values
end


  








  

    #adapter  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 171



def adapter
  configuration_hash[:adapter]&.to_s
end


  








  

    #checkout_timeout  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 133



def checkout_timeout
  (configuration_hash[:checkout_timeout] || 5).to_f
end


  








  

    #comparable_values  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 54



def comparable_values # :nodoc:
  super << configuration_hash
end


  








  

    #database  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 79



def database
  configuration_hash[:database]
end


  








  

    #default_reaping_frequency   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 253



def default_reaping_frequency
  # Reap every 20 seconds by default, but run more often as necessary to
  # meet other configured timeouts.
  [20, idle_timeout, max_age, keepalive].compact.min
end


  








  

    #default_schema_cache_path(db_dir = "db")  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 181



def default_schema_cache_path(db_dir = "db")
  if primary?
    File.join(db_dir, "schema_cache.yml")
  else
    File.join(db_dir, "#{name}_schema_cache.yml")
  end
end


  








  

    #eql?(other)  
  



  

    
Alias for #==.

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 48



alias :eql? :==


  








  

    #hash  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 50



def hash # :nodoc:
  comparable_values.hash
end


  








  

    #host  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 71



def host
  configuration_hash[:host]
end


  








  

    #idle_timeout  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 146



def idle_timeout
  default = 300
  case timeout = configuration_hash.fetch(:idle_timeout, default)
  when nil, false
    nil
  when true
    default.to_f
  else
    timeout = timeout.to_f
    timeout if timeout > 0
  end
end


  








  

    #keepalive  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 159



def keepalive
  case keepalive = configuration_hash[:keepalive]
  when false
    nil
  when nil, true
    600.0 # default
  else
    keepalive = keepalive.to_f
    keepalive if keepalive > 0.0
  end
end


  








  

    #lazy_schema_cache_path  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 189



def lazy_schema_cache_path
  schema_cache_path || default_schema_cache_path
end


  








  

    #max_age  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 109



def max_age
  case v = configuration_hash[:max_age]
  when nil, false
    Float::INFINITY
  else
    v = v.to_i
    v > 0 ? v : Float::INFINITY
  end
end


  








  

    #max_connections  
    Also known as: #pool
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 87



def max_connections
  max_connections = configuration_hash.fetch(:max_connections) {
    configuration_hash.fetch(:pool, 5)
  }&.to_i
  max_connections if max_connections && max_connections >= 0
end


  








  

    #max_queue  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 129



def max_queue
  max_threads * 4
end


  








  

    #max_threads  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 105



def max_threads
  (configuration_hash[:max_threads] || (max_connections || 5).clamp(0, 5)).to_i
end


  








  

    #migrations_paths  
  



  

    
The migrations paths for a database configuration. If the migrations_paths
key is present in the config, migrations_paths will return its value.

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 67



def migrations_paths
  configuration_hash[:migrations_paths]
end


  








  

    #min_connections  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 94



def min_connections
  (configuration_hash[:min_connections] || 0).to_i
end


  








  

    #min_threads  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 101



def min_threads
  (configuration_hash[:min_threads] || 0).to_i
end


  








  

    #pool  
  



  

    
Deprecated. 
use max_connections instead


Alias for #max_connections.

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 98



alias :pool :max_connections


  








  

    #query_cache  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 119



def query_cache
  configuration_hash[:query_cache]
end


  








  

    #query_log_tags_config  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 123



def query_log_tags_config # :nodoc:
  configuration_hash[:query_log_tags]
end


  








  

    #reaping_frequency  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 137



def reaping_frequency # :nodoc:
  case frequency = configuration_hash.fetch(:reaping_frequency, default_reaping_frequency)
  when nil, false
    nil
  else
    frequency.to_f
  end
end


  








  

    #schema_cache_path  
  



  

    
The path to the schema cache dump file for a database. If omitted, the
filename will be read from ENV or a default will be derived.

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 177



def schema_cache_path
  configuration_hash[:schema_cache_path]
end


  








  

    #schema_dump(format = schema_format)  
  



  

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


If configuration_hash[:schema_dump] is set to false or nil the schema
will not be dumped.


If the config option is set that will be used. Otherwise Rails will generate
the filename from the database config name.

  



  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 213



def schema_dump(format = schema_format)
  if configuration_hash.key?(:schema_dump)
    if config = configuration_hash[:schema_dump]
      config
    end
  elsif primary?
    schema_file_type(format)
  else
    "#{name}_#{schema_file_type(format)}"
  end
end


  








  

    #schema_file_type(format)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 244



def schema_file_type(format)
  case format.to_sym
  when :ruby
    "schema.rb"
  when :sql
    "structure.sql"
  end
end


  








  

    #schema_format  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 225



def schema_format # :nodoc:
  format = configuration_hash.fetch(:schema_format, ActiveRecord.schema_format).to_sym
  raise "Invalid schema format" unless [:ruby, :sql].include?(format)
  format
end


  








  

    #socket  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 75



def socket # :nodoc:
  configuration_hash[:socket]
end


  








  

    #validate_configuration!   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/database_configurations/hash_config.rb', line 259



def validate_configuration!
  if configuration_hash[:pool] && configuration_hash[:max_connections]
    pool_val = configuration_hash[:pool].to_i
    max_conn_val = configuration_hash[:max_connections].to_i

    if pool_val != max_conn_val
      raise "Ambiguous configuration: 'pool' (#{pool_val}) and 'max_connections' (#{max_conn_val}) are set to different values. Prefer just 'max_connections'."
    end
  end

  if configuration_hash[:pool] && configuration_hash[:min_connections]
    raise "Ambiguous configuration: when setting 'min_connections', use 'max_connections' instead of 'pool'."
  end
end