跳至内容 跳至搜索

Active Record 数据库配置

ActiveRecord::DatabaseConfigurations 返回一个 DatabaseConfig 对象数组，这些对象由应用程序的数据库配置哈希或 URL 字符串构建。

应用程序中 DatabaseConfig 对象的数组默认为 HashConfig 或 UrlConfig。你可以使用 ActiveRecord::Base.configurations 检索应用程序的配置。

如果你注册一个自定义处理程序，对象将根据处理程序的条件创建。有关注册自定义处理程序的更多信息，请参阅 ::register_db_config_handler。

命名空间
方法
B
C
E
F
N
R

属性

[R] configurations

类公共方法

new(configurations = {})

源代码： 显示 | 在 GitHub 上 

# File activerecord/lib/active_record/database_configurations.rb, line 73
def initialize(configurations = {})
  @configurations = build_configs(configurations)
end

register_db_config_handler(&block)

允许应用程序为数据库配置对象注册自定义处理程序。这对于创建自定义处理程序非常有用，该处理程序响应应用程序需要但 Active Record 未实现的方法。例如，如果你正在使用 Vitess，你可能希望你的 Vitess 配置响应“sharded?”。要在初始化程序中实现此功能，请定义以下内容

ActiveRecord::DatabaseConfigurations.register_db_config_handler do |env_name, name, url, config|
  next unless config.key?(:vitess)
  VitessConfig.new(env_name, name, config)
end

注意：应用程序必须在你的处理程序注册中处理应该创建自定义配置的条件，否则所有对象都将使用自定义处理程序。

然后定义您的 VitessConfig 以响应应用程序所需的方法。建议您从现有数据库配置类中继承，以避免重新实现所有方法。自定义配置处理程序应仅实现 Active Record 未实现的方法。

class VitessConfig < ActiveRecord::DatabaseConfigurations::UrlConfig
  def sharded?
    configuration_hash.fetch("sharded", false)
  end
end

对于具有 :vitess 键的配置，将创建 VitessConfig 对象，而不是 UrlConfig。

来源：显示 | 在 GitHub 上 

# File activerecord/lib/active_record/database_configurations.rb, line 61
def self.register_db_config_handler(&block)
  db_config_handlers << block
end

实例公共方法

blank?()

别名：empty?

configs_for(env_name: nil, name: nil, config_key: nil, include_hidden: false)

收集环境的配置，还可以选择传入的规范名称。要包括副本配置，请传递 include_hidden: true。

如果提供了名称，将返回单个 DatabaseConfig 对象，否则将返回与请求的环境和类型相对应的 DatabaseConfig 对象数组。

选项

  • env_name: 环境名称。默认为 nil，它将收集所有环境的配置。

  • name: 数据库配置名称（即主、动物等）。默认为 nil。如果没有指定 env_name，将返回默认环境和已传递 name 的配置。

  • config_key: 选择在配置哈希中包含特定键的配置。对于选择使用自定义数据库配置处理程序的配置或查找哈希中包含特定键的配置很有用。

  • include_hidden: 确定是否在返回的列表中包括副本和由 database_tasks: false 隐藏的配置。大多数情况下，我们只遍历主连接（即，不需要为写和读连接运行迁移）。默认为 false。

来源：显示 | 在 GitHub 上 

# File activerecord/lib/active_record/database_configurations.rb, line 98
def configs_for(env_name: nil, name: nil, config_key: nil, include_hidden: false)
  env_name ||= default_env if name
  configs = env_with_configs(env_name)

  unless include_hidden
    configs = configs.select do |db_config|
      db_config.database_tasks?
    end
  end

  if config_key
    configs = configs.select do |db_config|
      db_config.configuration_hash.key?(config_key)
    end
  end

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

empty?()

检查应用程序的配置是否为空。

别名：blank?

来源：显示 | 在 GitHub 上 

# File activerecord/lib/active_record/database_configurations.rb, line 150
def empty?
  configurations.empty?
end

find_db_config(env)

返回一个基于所请求环境的单个 DatabaseConfig 对象。

如果应用程序有多个数据库，find_db_config 将返回该环境的第一个 DatabaseConfig。

来源：显示 | 在 GitHub 上 

# File activerecord/lib/active_record/database_configurations.rb, line 127
def find_db_config(env)
  env = env.to_s
  configurations.find do |db_config|
    db_config.for_current_env? && (db_config.env_name == env || db_config.name == env)
  end || configurations.find do |db_config|
    db_config.env_name == env
  end
end