класс 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) -
checkout_timeout: количество секунд ожидания подключения перед отказом и выбросом ошибки таймаута (по умолчанию 5 секунд). -
reaping_frequency: частота в секундах для периодического запуска сборщика, который пытается найти и восстановить подключения от «мертвых» потоков, что может произойти, если программист забывает закрыть подключение в конце потока или поток завершается неожиданно. Независимо от этого параметра, сборщик будет вызван перед каждым ожиданием с блокировкой. (По умолчаниюnil, что означает не планировать сборщик).
Атрибуты
Общественные методы класса
# 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 @reaper = Reaper.new(self, (spec.config[:reaping_frequency] && spec.config[:reaping_frequency].to_f)) @reaper.run # 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 +@thread_cached_conns+ 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 end
Создаёт новый объект ConnectionPool. spec — это объект ConnectionSpecification, описывающий информацию о подключении к базе данных (например, адаптер, имя хоста, имя пользователя, пароль и т. д.), а также максимальный размер для этого ConnectionPool.
Максимальный размер ConnectionPool по умолчанию составляет 5.
Методы публичного экземпляра
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 382 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 508
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 499 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 457
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 481 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 414
def connected?
synchronize { @connections.any? }
end Возвращает true, если соединение уже открыто.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 373 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 424
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 446 def disconnect! disconnect(false) end
Отключает все соединения в пуле и очищает пул.
Пул сначала пытается получить доступ ко всем соединениям. Если это не удается в течение заданного времени ожидания (по умолчанию spec.config[:checkout_timeout] * 2 секунды), пул отключается принудительно, не обращая внимания на другие нити, владеющие соединениями.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 360
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 556
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 Восстановление потерянных соединений для пула. Потеря соединения может произойти, если программист забыл выполнить checkin соединения в конце нити или нить неожиданно завершилась.
# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 393
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 524
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 583
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 403
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.