123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::DatabaseConfigurations

Overview

DatabaseConfigurations returns an array of DatabaseConfig objects (either a HashConfig or UrlConfig) that are constructed from the application’s database configuration hash or URL string.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(configurations = {}) ⇒ DatabaseConfigurations

[ GitHub ] 

  


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



def initialize(configurations = {})
  @configurations = build_configs(configurations)
end


  







Instance Attribute Details



  

    #blank?   (readonly)
  



  

    

Alias for #empty?.


  



  [ GitHub ]


  

  


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



alias :blank? :empty?


  








  

    #configurations   (readonly)
  

  [ GitHub ]


  

  


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



attr_reader :configurations


  








  

    #empty?  ⇒ Boolean  (readonly)
    Also known as: #blank?
  



  

    

Checks if the application’s configurations are empty.



Aliased to blank?


  





  


  [ GitHub ]


  

  


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



def empty?
  configurations.empty?
end


  







Instance Method Details



  

    #[](env = default_env)  
  



  

    

Alias for #default_hash.


  



  [ GitHub ]


  

  


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



alias :[] :default_hash


  








  

    #any?  ⇒ Boolean 
  



  

    
  





  


  [ GitHub ]


  

  


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



delegate :any?, to: :configurations


  








  

    #configs_for(env_name: nil, spec_name: nil, name: nil, include_replicas: false)  
  



  

    

Collects the configs for the environment and optionally the specification name passed in. To include replica configurations pass include_replicas: true.



If a name is provided a single DatabaseConfigurations::DatabaseConfig object will be returned, otherwise an array of DatabaseConfigurations::DatabaseConfig objects will be returned that corresponds with the environment and type requested.



Options


  • 

    env_name: The environment name. Defaults to nil which will collect configs for all environments.
    

  • 

    name: The db config name (i.e. primary, animals, etc.). Defaults to nil. If no env_name is specified the config for the default env and the passed name will be returned.
    

  • 

    include_replicas: Determines whether to include replicas in the returned list. Most of the time we’re only iterating over the write connection (i.e. migrations don’t need to run for the write and read connection). Defaults to false.
    



  



  [ GitHub ]


  

  


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



def configs_for(env_name: nil, spec_name: nil, name: nil, include_replicas: false)
  if spec_name
    name = spec_name
    ActiveSupport::Deprecation.warn("The kwarg `spec_name` is deprecated in favor of `name`. `spec_name` will be removed in Rails 7.0")
  end

  env_name ||= default_env if name
  configs = env_with_configs(env_name)

  unless include_replicas
    configs = configs.select do |db_config|
      !db_config.replica?
    end
  end

  if name
    configs.find do |db_config|
      db_config.name == name
    end
  else
    configs
  end
end


  








  

    #default_hash(env = default_env)  
    Also known as: #[]
  



  

    
Deprecated. 


Use configs_for





Returns the config hash that corresponds with the environment



If the application has multiple databases default_hash will return the first config hash for the environment.



{ database: "my_db", adapter: "mysql2" }


  



  [ GitHub ]


  

  


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



def default_hash(env = default_env)
  default = find_db_config(env)
  default.configuration_hash if default
end


  








  

    #find_db_config(env)  
  



  

    

Returns a single DatabaseConfigurations::DatabaseConfig object based on the requested environment.



If the application has multiple databases find_db_config will return the first DatabaseConfigurations::DatabaseConfig for the environment.


  



  [ GitHub ]


  

  


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



def find_db_config(env)
  configurations
    .sort_by.with_index { |db_config, i| db_config.for_current_env? ? [0, i] : [1, i] }
    .find do |db_config|
      db_config.env_name == env.to_s ||
        (db_config.for_current_env? && db_config.name == env.to_s)
    end
end


  








  

    #to_h  
  



  

    
Deprecated. 


You can use ‘ActiveRecord::Base.configurations.configs_for(env_name: ’env’, name: ‘primary’).configuration_hash` to get the configuration hashes.





Returns the DatabaseConfigurations object as a ::Hash.


  



  [ GitHub ]


  

  


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



def to_h
  configurations.inject({}) do |memo, db_config|
    memo.merge(db_config.env_name => db_config.configuration_hash.stringify_keys)
  end
end