class Sequel::ConnectionPool

  1. lib/sequel/connection_pool.rb
Parent: Sequel

The base connection pool class, which all other connection pools are based on. This class is not instantiated directly, but subclasses should at the very least implement the following API:

initialize(Hash, &block)

The block is used as the connection proc, which should accept a single symbol argument.

hold(Symbol, &block)

Yield a connection object (obtained from calling the block passed to initialize) to the current block. For sharded connection pools, the Symbol passed is the shard/server to use.

disconnect(Symbol, &block)

Disconnect the connection object. If a block is given, pass the connection option to it, otherwise use the :disconnection_proc option in the hash passed to initialize. For sharded connection pools, the Symbol passed is the shard/server to use.

servers

An array of shard/server symbols for all shards/servers that this connection pool recognizes.

size

an integer representing the total number of connections in the pool, or for the given shard/server if sharding is supported.

For sharded connection pools, the sharded API adds the following methods:

add_servers(Array of Symbols)

start recognizing all shards/servers specified by the array of symbols.

  • remove_servers(Array of Symbols)

    no longer recognize all shards/servers specified by the array of symbols.

Methods

Public Class

  1. new

Public Instance

  1. created_count
  2. servers

Constants

CONNECTION_POOL_MAP = {[true, false] => :single, [true, true] => :sharded_single, [false, false] => :threaded, [false, true] => :sharded_threaded}  

A map of [single threaded, sharded] values to symbols or ConnectionPool subclasses.
DEFAULT_SERVER = :default  

The default server to use

Public Class methods

new (opts={}, &block)

Instantiates a connection pool with the given options. The block is called with a single symbol (specifying the server/shard to use) every time a new connection is needed. The following options are respected for all connection pools:

:after_connect

The proc called after each new connection is made, with the connection object, useful for customizations that you want to apply to all connections.

:disconnection_proc

The proc called when removing connections from the pool, which is passed the connection to disconnect.

[show source] 
# File lib/sequel/connection_pool.rb, line 70
def initialize(opts={}, &block)
  raise(Sequel::Error, "No connection proc specified") unless @connection_proc = block
  @disconnection_proc = opts[:disconnection_proc]
  @after_connect = opts[:after_connect]
end

Public Instance methods

created_count (*args)

Alias for size, not aliased directly for ease of subclass implementation

[show source] 
# File lib/sequel/connection_pool.rb, line 77
def created_count(*args)
  size(*args)
end
servers ()

An array of symbols for all shards/servers, which is a single :default by default.

[show source] 
# File lib/sequel/connection_pool.rb, line 82
def servers
  [:default]
end