class ActiveRecord::ConnectionAdapters::ConnectionHandler

Родитель:: Объект

ConnectionHandler — это коллекция объектов ConnectionPool. Она используется для хранения отдельных пулов соединений, которые подключаются к различным базам данных.

Например, предположим, что у вас есть 5 моделей со следующей иерархией:

class Author < ActiveRecord::Base
end

class BankAccount < ActiveRecord::Base
end

class Book < ActiveRecord::Base
  establish_connection "library_db"
end

class ScaryBook < Book
end

class GoodBook < Book
end

И файл database.yml, который выглядит так:

development:
  database: my_application
  host: localhost

library_db:
  database: library
  host: some.library.org

Ваша основная база данных в среде разработки — “my_application”, но модель Book подключается к отдельной базе данных под названием “library_db” (это может быть даже база данных на другом компьютере).

Book, ScaryBook и GoodBook будут использовать один и тот же пул соединений для “library_db”, в то время как Author, BankAccount и любые другие созданные вами модели будут использовать стандартный пул соединений для “my_application”.

Различные пулы соединений управляются единственным экземпляром ConnectionHandler, доступным через ActiveRecord::Core.connection_handler. Все модели Active Record используют этот обработчик для определения пула соединений, который они должны использовать.

Класс ConnectionHandler не связан с моделями Active, так как он не знает о модели. Модель должна передать имя спецификации обработчику, чтобы найти соответствующий пул соединений.

Публичные методы класса

new() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 866
def initialize
  # These caches are keyed by spec.name (ConnectionSpecification#name).
  @owner_to_pool = Concurrent::Map.new(initial_capacity: 2) do |h, k|
    h[k] = Concurrent::Map.new(initial_capacity: 2)
  end
end

Публичные методы экземпляра

active_connections?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 902
def active_connections?
  connection_pool_list.any?(&:active_connection?)
end

Возвращает true, если существуют активные соединения среди пулов соединений, которые управляет ConnectionHandler.

clear_active_connections!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 909
def clear_active_connections!
  connection_pool_list.each(&:release_connection)
end

Возвращает любые используемые соединения текущей нити обратно в пул, а также возвращает соединения в пул, кэшированные нитями, которые больше не активны.

clear_all_connections!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 920
def clear_all_connections!
  connection_pool_list.each(&:disconnect!)
end

clear_reloadable_connections!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 916
def clear_reloadable_connections!
  connection_pool_list.each(&:clear_reloadable_connections!)
end

Очищает кэш, который сопоставляет классы.

См. ActiveRecord::ConnectionAdapters::ConnectionPool#clear_reloadable_connections! для получения подробностей.

connected?(spec_name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 938
def connected?(spec_name)
  conn = retrieve_connection_pool(spec_name)
  conn && conn.connected?
end

Возвращает true, если соединение, доступное этому классу, уже открыто.

connection_pool_list() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 873
def connection_pool_list
  owner_to_pool.values.compact
end

Также алиас: connection_pools

connection_pools()

Псевдоним для: connection_pool_list

establish_connection(config) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 878
def establish_connection(config)
  resolver = ConnectionSpecification::Resolver.new(Base.configurations)
  spec = resolver.spec(config)

  remove_connection(spec.name)

  message_bus = ActiveSupport::Notifications.instrumenter
  payload = {
    connection_id: object_id
  }
  if spec
    payload[:spec_name] = spec.name
    payload[:config] = spec.config
  end

  message_bus.instrument("!connection.active_record", payload) do
    owner_to_pool[spec.name] = ConnectionAdapters::ConnectionPool.new(spec)
  end

  owner_to_pool[spec.name]
end

remove_connection(spec_name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 947
def remove_connection(spec_name)
  if pool = owner_to_pool.delete(spec_name)
    pool.automatic_reconnect = false
    pool.disconnect!
    pool.spec.config
  end
end

Удаляет соединение для этого класса. Это закроет активное соединение и определенное соединение (если они существуют). Результат может быть использован в качестве аргумента для establish_connection для удобного повторного подключения.

retrieve_connection_pool(spec_name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 958
def retrieve_connection_pool(spec_name)
  owner_to_pool.fetch(spec_name) do
    # Check if a connection was previously established in an ancestor process,
    # which may have been forked.
    if ancestor_pool = pool_from_any_process_for(spec_name)
      # A connection was established in an ancestor process that must have
      # subsequently forked. We can't reuse the connection, but we can copy
      # the specification and establish a new connection with it.
      establish_connection(ancestor_pool.spec.to_hash).tap do |pool|
        pool.schema_cache = ancestor_pool.schema_cache if ancestor_pool.schema_cache
      end
    else
      owner_to_pool[spec_name] = nil
    end
  end
end

Получение пула соединений происходит часто, поэтому мы кэшируем его в @owner_to_pool. Это делает получение пула соединений O(1) после того, как процесс разогрет. При установлении или удалении соединения мы аннулируем кэш.