Active Record 连接池

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 206
def install_executor_hooks(executor = ActiveSupport::Executor)
  executor.register_hook(ExecutorHooks)
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 226
def initialize(pool_config)
  super()

  @pool_config = pool_config
  @db_config = pool_config.db_config
  @role = pool_config.role
  @shard = pool_config.shard

  @checkout_timeout = db_config.checkout_timeout
  @idle_timeout = db_config.idle_timeout
  @size = db_config.pool

  # 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 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>@leases</tt> does not require
  # synchronization.
  @leases = LeaseRegistry.new

  @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
  @pinned_connection = nil
  @pinned_connections_depth = 0

  @async_executor = build_async_executor

  @schema_cache = nil

  @reaper = Reaper.new(self, db_config.reaping_frequency)
  @reaper.run
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 370
def active_connection?
  connection_lease.connection
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 564
def checkin(conn)
  return if @pinned_connection.equal?(conn)

  conn.lock.synchronize do
    synchronize do
      connection_lease.clear(conn)

      conn._run_checkin_callbacks do
        conn.expire
      end

      @available.add conn
    end
  end
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 541
def checkout(checkout_timeout = @checkout_timeout)
  if @pinned_connection
    @pinned_connection.lock.synchronize do
      synchronize do
        @pinned_connection.verify!
        # Any leased connection must be in @connections otherwise
        # some methods like #connected? won't behave correctly
        unless @connections.include?(@pinned_connection)
          @connections << @pinned_connection
        end
      end
    end
    @pinned_connection
  else
    checkout_and_verify(acquire_connection(checkout_timeout))
  end
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 499
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

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 523
def clear_reloadable_connections!
  clear_reloadable_connections(false)
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 421
def connected?
  synchronize { @connections.any?(&:connected?) }
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 436
def connections
  synchronize { @connections.dup }
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 446
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 = []
      @leases.clear
      @available.clear
    end
  end
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 469
def disconnect!
  disconnect(false)
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 637
def flush(minimum_idle = @idle_timeout)
  return if minimum_idle.nil?

  idle_connections = synchronize do
    return if self.discarded?
    @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

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 659
def flush!
  reap
  flush(-1)
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 309
def lease_connection
  lease = connection_lease
  lease.sticky = true
  lease.connection ||= checkout
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 614
def reap
  stale_connections = synchronize do
    return if self.discarded?
    @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 382
def release_connection(existing_lease = nil)
  if conn = connection_lease.release
    checkin conn
    return true
  end
  false
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 582
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 279
def schema_cache
  @schema_cache ||= BoundSchemaReflection.new(schema_reflection, self)
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 283
def schema_reflection=(schema_reflection)
  pool_config.schema_reflection = schema_reflection
  @schema_cache = nil
end

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 671
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

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 399
def with_connection(prevent_permanent_checkout: false)
  lease = connection_lease
  sticky_was = lease.sticky
  lease.sticky = false if prevent_permanent_checkout

  if lease.connection
    begin
      yield lease.connection
    ensure
      lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
    end
  else
    begin
      yield lease.connection = checkout
    ensure
      lease.sticky = sticky_was if prevent_permanent_checkout && !sticky_was
      release_connection(lease) unless lease.sticky
    end
  end
end