класс ActiveRecord::ConnectionAdapters::ConnectionPool
Базовый класс пула соединений для управления базами данных Active Record.
Введение
Пул соединений синхронизирует доступ потоков к ограниченному количеству подключений к базе данных. Основная идея заключается в том, что каждый поток запрашивает подключение к базе данных из пула, использует его и возвращает обратно в пул. ConnectionPool полностью потокобезопасен и гарантирует, что подключение не может использоваться двумя потоками одновременно, при условии правильного соблюдения контракта ConnectionPool. Он также обрабатывает случаи, когда количество потоков больше, чем подключений: если все подключения заняты, и поток пытается получить подключение, то ConnectionPool будет ожидать, пока другой поток не вернёт подключение.
Получение (выдача) подключения
Подключения могут быть получены и использованы из пула несколькими способами:
-
Просто используйте ActiveRecord::Base.connection, как в Active Record 2.1 и более ранних версиях (до пулов подключений). В конечном итоге, когда вы закончите работу с подключением(ями) и хотите вернуть его в пул, вызывайте ActiveRecord::Base.clear_active_connections!. Это будет стандартным поведением Active Record при использовании в сочетании с циклом обработки запросов Action Pack.
-
Вручную выдайте подключение из пула с помощью ActiveRecord::Base.connection_pool.checkout. Вы несете ответственность за возврат этого подключения в пул после завершения работы, вызвав ActiveRecord::Base.connection_pool.checkin(connection).
-
Используйте ActiveRecord::Base.connection_pool.with_connection(&block), который получает подключение, передает его в качестве единственного аргумента в блок и возвращает его в пул после завершения блока.
Подключения в пуле фактически являются объектами AbstractAdapter (или объектами, совместимыми с интерфейсом AbstractAdapter).
Параметры
Существует несколько параметров, связанных с пулом подключений, которые вы можете добавить в конфигурацию подключения к вашей базе данных:
-
pool: максимальное количество подключений, которые может управлять пул (по умолчанию 5). -
idle_timeout: количество секунд, в течение которых подключение будет оставаться неиспользуемым в пуле перед его автоматической развязкой (по умолчанию 300 секунд). Установите значение 0, чтобы подключения хранились постоянно. -
checkout_timeout: количество секунд ожидания подключения, прежде чем отказаться и сгенерировать ошибку таймаута (по умолчанию 5 секунд).
Атрибуты
Общедоступные методы класса
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 321
def initialize(spec)
super()
@spec = spec
@checkout_timeout = (spec.config[:checkout_timeout] && spec.config[:checkout_timeout].to_f) || 5
if @idle_timeout = spec.config.fetch(:idle_timeout, 300)
@idle_timeout = @idle_timeout.to_f
@idle_timeout = nil if @idle_timeout <= 0
end
# default max pool size to 5
@size = (spec.config[:pool] && spec.config[:pool].to_i) || 5
# This variable tracks the cache of threads mapped to reserved connections, with the
# sole purpose of speeding up the +connection+ method. It is not the authoritative
# registry of which thread owns which connection. Connection ownership is tracked by
# the +connection.owner+ attr on each +connection+ instance.
# The invariant works like this: if there is mapping of <tt>thread => conn</tt>,
# then that +thread+ does indeed own that +conn+. However, an absence of a such
# mapping does not mean that the +thread+ doesn't own the said connection. In
# that case +conn.owner+ attr should be consulted.
# Access and modification of <tt>@thread_cached_conns</tt> does not require
# synchronization.
@thread_cached_conns = Concurrent::Map.new(initial_capacity: @size)
@connections = []
@automatic_reconnect = true
# Connection pool allows for concurrent (outside the main +synchronize+ section)
# establishment of new connections. This variable tracks the number of threads
# currently in the process of independently establishing connections to the DB.
@now_connecting = 0
@threads_blocking_new_connections = 0
@available = ConnectionLeasingQueue.new self
@lock_thread = false
# +reaping_frequency+ is configurable mostly for historical reasons, but it could
# also be useful if someone wants a very low +idle_timeout+.
reaping_frequency = spec.config.fetch(:reaping_frequency, 60)
@reaper = Reaper.new(self, reaping_frequency && reaping_frequency.to_f)
@reaper.run
end Создает новый объект ConnectionPool. spec — это объект ConnectionSpecification, описывающий информацию о подключении к базе данных (например, адаптер, имя хоста, имя пользователя, пароль и т.д.), а также максимальный размер для этого ConnectionPool.
По умолчанию максимальный размер ConnectionPool равен 5.
Публичные методы экземпляра
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 390 def active_connection? @thread_cached_conns[connection_cache_key(Thread.current)] end
Возвращает true, если есть открытое соединение, используемое для текущего потока.
Этот метод работает только для соединений, полученных с помощью методов connection или with_connection. Соединения, полученные через checkout, не будут обнаружены active_connection?.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 531
def checkin(conn)
conn.lock.synchronize do
synchronize do
remove_connection_from_thread_cache conn
conn._run_checkin_callbacks do
conn.expire
end
@available.add conn
end
end
end Возвращает соединение с базой данных в пул, указывая, что вам больше не нужно это соединение.
conn: объект AbstractAdapter, который был получен ранее вызовом checkout этого пула.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 522 def checkout(checkout_timeout = @checkout_timeout) checkout_and_verify(acquire_connection(checkout_timeout)) end
Извлекает соединение с базой данных из пула, указывая, что вы хотите его использовать. Вы должны вызвать checkin, когда оно вам больше не понадобится.
Это делается либо путем возврата и аренды существующего соединения, либо путем создания нового соединения и его аренды.
Если все соединения арендованы, и пул достиг своей максимальной вместимости (т.е. количество текущих арендованных соединений больше или равно установленному пределу размера), будет возбуждено исключение ActiveRecord::ConnectionTimeoutError.
Возвращает: объект AbstractAdapter.
Вызывает:
-
ActiveRecord::ConnectionTimeoutError соединение не может быть получено из пула.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 480
def clear_reloadable_connections(raise_on_acquisition_timeout = true)
with_exclusively_acquired_all_connections(raise_on_acquisition_timeout) do
synchronize do
@connections.each do |conn|
if conn.in_use?
conn.steal!
checkin conn
end
conn.disconnect! if conn.requires_reloading?
end
@connections.delete_if(&:requires_reloading?)
@available.clear
end
end
end Очищает кэш, который сопоставляет классы, и переподключает соединения, требующие перезагрузки.
Вызывает:
-
ActiveRecord::ExclusiveConnectionTimeoutError если невозможно получить право владения всеми соединениями в пуле в течение интервала времени ожидания (время по умолчанию составляет
spec.config[:checkout_timeout] * 2секунд).
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 504 def clear_reloadable_connections! clear_reloadable_connections(false) end
Очищает кэш, который сопоставляет классы, и переподключает соединения, требующие перезагрузки.
Пул сначала пытается получить право владения всеми соединениями. Если это невозможно сделать в течение интервала времени ожидания (время по умолчанию составляет spec.config[:checkout_timeout] * 2 секунд), то пул принудительно очищает кэш и перезагружает соединения, не обращая внимания на другие потоки, владеющие соединениями.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 422
def connected?
synchronize { @connections.any? }
end Возвращает true, если соединение уже открыто.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 381 def connection @thread_cached_conns[connection_cache_key(@lock_thread || Thread.current)] ||= checkout end
Извлекает соединение, связанное с текущим потоком, или вызывает checkout для получения соединения, если необходимо.
connection может вызываться любое количество раз; соединение хранится в кэше, ключом которого является поток.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 432
def disconnect(raise_on_acquisition_timeout = true)
with_exclusively_acquired_all_connections(raise_on_acquisition_timeout) do
synchronize do
@connections.each do |conn|
if conn.in_use?
conn.steal!
checkin conn
end
conn.disconnect!
end
@connections = []
@available.clear
end
end
end Отключает все соединения в пуле и очищает пул.
Вызывает:
-
ActiveRecord::ExclusiveConnectionTimeoutError если невозможно получить право владения всеми соединениями в пуле в течение интервала времени ожидания (время по умолчанию составляет
spec.config[:checkout_timeout] * 2секунд).
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 454 def disconnect! disconnect(false) end
Отключает все соединения в пуле и очищает пул.
Пул сначала пытается получить право владения всеми соединениями. Если это невозможно сделать в течение интервала времени ожидания (время по умолчанию составляет spec.config[:checkout_timeout] * 2 секунд), то пул принудительно отключается, не обращая внимания на другие потоки, владеющие соединениями.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 601
def flush(minimum_idle = @idle_timeout)
return if minimum_idle.nil?
idle_connections = synchronize do
@connections.select do |conn|
!conn.in_use? && conn.seconds_idle >= minimum_idle
end.each do |conn|
conn.lease
@available.delete conn
@connections.delete conn
end
end
idle_connections.each do |conn|
conn.disconnect!
end
end Отключает все соединения, которые были неактивны в течение как минимум minimum_idle секунд. Соединения, в настоящее время взятые в аренду, или те, которые были возвращены менее чем minimum_idle секунд назад, не затрагиваются.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 622 def flush! reap flush(-1) end
Отключает все текущие неактивные соединения. Текущие арендованные соединения не затрагиваются.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 368
def lock_thread=(lock_thread)
if lock_thread
@lock_thread = Thread.current
else
@lock_thread = nil
end
end # File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 579
def reap
stale_connections = synchronize do
@connections.select do |conn|
conn.in_use? && !conn.owner.alive?
end.each do |conn|
conn.steal!
end
end
stale_connections.each do |conn|
if conn.active?
conn.reset!
checkin conn
else
remove conn
end
end
end Восстанавливает потерянные соединения для пула. Потерянное соединение может возникнуть, если программист забудет вернуть соединение в конце потока или поток неожиданно завершится.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 401
def release_connection(owner_thread = Thread.current)
if conn = @thread_cached_conns.delete(connection_cache_key(owner_thread))
checkin conn
end
end Сигнализирует о том, что поток завершил работу с текущим соединением. release_connection освобождает связь соединение-поток и возвращает соединение в пул.
Этот метод работает только для соединений, полученных с помощью методов connection или with_connection, соединения, полученные через checkout, не будут автоматически освобождены.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 547
def remove(conn)
needs_new_connection = false
synchronize do
remove_connection_from_thread_cache conn
@connections.delete conn
@available.delete conn
# @available.any_waiting? => true means that prior to removing this
# conn, the pool was at its max size (@connections.size == @size).
# This would mean that any threads stuck waiting in the queue wouldn't
# know they could checkout_new_connection, so let's do it for them.
# Because condition-wait loop is encapsulated in the Queue class
# (that in turn is oblivious to ConnectionPool implementation), threads
# that are "stuck" there are helpless. They have no way of creating
# new connections and are completely reliant on us feeding available
# connections into the Queue.
needs_new_connection = @available.any_waiting?
end
# This is intentionally done outside of the synchronized section as we
# would like not to hold the main mutex while checking out new connections.
# Thus there is some chance that needs_new_connection information is now
# stale, we can live with that (bulk_make_new_connections will make
# sure not to exceed the pool's @size limit).
bulk_make_new_connections(1) if needs_new_connection
end Удаляет соединение из пула соединений. Соединение останется открытым и активным, но больше не будет управляться этим пулом.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 635
def stat
synchronize do
{
size: size,
connections: @connections.size,
busy: @connections.count { |c| c.in_use? && c.owner.alive? },
dead: @connections.count { |c| c.in_use? && !c.owner.alive? },
idle: @connections.count { |c| !c.in_use? },
waiting: num_waiting_in_queue,
checkout_timeout: checkout_timeout
}
end
end Возвращает статистику использования пула соединений. Пример:
ActiveRecord::Base.connection_pool.stat # => { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 411
def with_connection
unless conn = @thread_cached_conns[connection_cache_key(Thread.current)]
conn = connection
fresh_connection = true
end
yield conn
ensure
release_connection if fresh_connection
end Если соединение, полученное с помощью методов connection или with_connection, уже существует, передает его в блок. Если такого соединения не существует, извлекает соединение, передает его в блок и возвращает соединение, когда закончит.
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.