class ActiveRecord::ConnectionAdapters::ConnectionPool

Parent:: Object
Included modules:

Connection pool base class for managing Active Record database connections.

Introduction

A connection pool synchronizes thread access to a limited number of database connections. The basic idea is that each thread checks out a database connection from the pool, uses that connection, and checks the connection back in. ConnectionPool is completely thread-safe, and will ensure that a connection cannot be used by two threads at the same time, as long as ConnectionPool's contract is correctly followed. It will also handle cases in which there are more threads than connections: if all connections have been checked out, and a thread tries to checkout a connection anyway, then ConnectionPool will wait until some other thread has checked in a connection.

Obtaining (checking out) a connection

Connections can be obtained and used from a connection pool in several ways:

Simply use ActiveRecord::Base.connection as with Active Record 2.1 and earlier (pre-connection-pooling). Eventually, when you're done with the connection(s) and wish it to be returned to the pool, you call ActiveRecord::Base.clear_active_connections!. This will be the default behavior for Active Record when used in conjunction with Action Pack's request handling cycle.
Manually check out a connection from the pool with ActiveRecord::Base.connection_pool.checkout. You are responsible for returning this connection to the pool when finished by calling ActiveRecord::Base.connection_pool.checkin(connection).
Use ActiveRecord::Base.connection_pool.with_connection(&block), which obtains a connection, yields it as the sole argument to the block, and returns it to the pool after the block completes.

Connections in the pool are actually AbstractAdapter objects (or objects compatible with AbstractAdapter's interface).

Options

There are several connection-pooling-related options that you can add to your database connection configuration:

pool: number indicating size of connection pool (default 5)
checkout_timeout: number of seconds to block and wait for a connection before giving up and raising a timeout error (default 5 seconds).
reaping_frequency: frequency in seconds to periodically run the Reaper, which attempts to find and close dead connections, which can occur if a programmer forgets to close a connection at the end of a thread or a thread dies unexpectedly. (Default nil, which means don't run the Reaper).
dead_connection_timeout: number of seconds from last checkout after which the Reaper will consider a connection reapable. (default 5 seconds).

Attributes

automatic_reconnect[RW]

checkout_timeout[RW]

connections[R]

dead_connection_timeout[RW]

reaper[R]

size[R]

spec[R]

Public Class Methods

new(spec) Show source

Creates a new ConnectionPool object. spec is a ConnectionSpecification object which describes database connection information (e.g. adapter, host name, username, password, etc), as well as the maximum size for this ConnectionPool.

The default ConnectionPool maximum size is 5.

Calls superclass method

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

  @spec = spec

  @checkout_timeout = (spec.config[:checkout_timeout] && spec.config[:checkout_timeout].to_f) || 5
  @dead_connection_timeout = (spec.config[:dead_connection_timeout] && spec.config[:dead_connection_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

  # The cache of reserved connections mapped to threads
  @reserved_connections = ThreadSafe::Cache.new(:initial_capacity => @size)

  @connections         = []
  @automatic_reconnect = true

  @available = Queue.new self
end

Public Instance Methods

active_connection?() Show source

Is there an open connection that is being used for the current thread?

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 270
def active_connection?
  synchronize do
    @reserved_connections.fetch(current_connection_id) {
      return false
    }.in_use?
  end
end

checkin(conn) Show source

Check-in a database connection back into the pool, indicating that you no longer need this connection.

conn: an AbstractAdapter object, which was obtained by earlier by calling checkout on this pool.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 362
def checkin(conn)
  synchronize do
    conn.run_callbacks :checkin do
      conn.expire
    end

    release conn

    @available.add conn
  end
end

checkout() Show source

Check-out a database connection from the pool, indicating that you want to use it. You should call checkin when you no longer need this.

This is done by either returning and leasing existing connection, or by creating a new connection and leasing it.

If all connections are leased and the pool is at capacity (meaning the number of currently leased connections is greater than or equal to the size limit set), an ActiveRecord::ConnectionTimeoutError exception will be raised.

Returns: an AbstractAdapter object.

Raises:

ConnectionTimeoutError: no connection can be obtained from the pool.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 349
def checkout
  synchronize do
    conn = acquire_connection
    conn.lease
    checkout_and_verify(conn)
  end
end

clear_reloadable_connections!() Show source

Clears the cache which maps classes.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 318
def clear_reloadable_connections!
  synchronize do
    @reserved_connections.clear
    @connections.each do |conn|
      checkin conn
      conn.disconnect! if conn.requires_reloading?
    end
    @connections.delete_if do |conn|
      conn.requires_reloading?
    end
    @available.clear
    @connections.each do |conn|
      @available.add conn
    end
  end
end

connected?() Show source

Returns true if a connection has already been opened.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 300
def connected?
  synchronize { @connections.any? }
end

connection() Show source

Retrieve the connection associated with the current thread, or call checkout to obtain one if necessary.

connection can be called any number of times; the connection is held in a hash keyed by the thread id.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 261
def connection
  # this is correctly done double-checked locking
  # (ThreadSafe::Cache's lookups have volatile semantics)
  @reserved_connections[current_connection_id] || synchronize do
    @reserved_connections[current_connection_id] ||= checkout
  end
end

disconnect!() Show source

Disconnects all connections in the pool, and clears the pool.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 305
def disconnect!
  synchronize do
    @reserved_connections.clear
    @connections.each do |conn|
      checkin conn
      conn.disconnect!
    end
    @connections = []
    @available.clear
  end
end

reap() Show source

Removes dead connections from the pool. A dead connection can occur if a programmer forgets to close a connection at the end of a thread or a thread dies unexpectedly.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 392
def reap
  synchronize do
    stale = Time.now - @dead_connection_timeout
    connections.dup.each do |conn|
      if conn.in_use? && stale > conn.last_use && !conn.active_threadsafe?
        remove conn
      end
    end
  end
end

release_connection(with_id = current_connection_id) Show source

Signal that the thread is finished with the current connection. release_connection releases the connection-thread association and returns the connection to the pool.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 281
def release_connection(with_id = current_connection_id)
  synchronize do
    conn = @reserved_connections.delete(with_id)
    checkin conn if conn
  end
end

remove(conn) Show source

Remove a connection from the connection pool. The connection will remain open and active but will no longer be managed by this pool.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 376
def remove(conn)
  synchronize do
    @connections.delete conn
    @available.delete conn

    # FIXME: we might want to store the key on the connection so that removing
    # from the reserved hash will be a little easier.
    release conn

    @available.add checkout_new_connection if @available.any_waiting?
  end
end

with_connection() { |connection| ... } Show source

If a connection already exists yield it to the block. If no connection exists checkout a connection, yield it to the block, and checkin the connection when finished.

# File activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb, line 291
def with_connection
  connection_id = current_connection_id
  fresh_connection = true unless active_connection?
  yield connection
ensure
  release_connection(connection_id) if fresh_connection
end