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 using the passed Sequel::Database object and options hash.
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 the connection object. For sharded connection pools, the Symbol passed is the shard/server to use.
An array of shard/server symbols for all shards/servers that this connection pool recognizes.
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:
start recognizing all shards/servers specified by the array of symbols.
no longer recognize all shards/servers specified by the array of symbols.
A map of [single threaded, sharded] values to symbols or ConnectionPool subclasses.
The default server to use
The #after_connect proc used for this pool. This is called with each new connection made, and is usually used to set custom per-connection settings.
The Sequel::Database object tied to this connection pool.
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:
The proc called after each new connection is made, with the connection object, useful for customizations that you want to apply to all connections.
# File lib/sequel/connection_pool.rb, line 75 def initialize(db, opts=OPTS) @db = db @after_connect = opts[:after_connect] end
Alias for size
, not aliased directly for ease of subclass
implementation
# File lib/sequel/connection_pool.rb, line 81 def created_count(*args) size(*args) end
An array of symbols for all shards/servers, which is a single
:default
by default.
# File lib/sequel/connection_pool.rb, line 86 def servers [DEFAULT_SERVER] end
Return a new connection by calling the connection proc with the given server name, and checking for connection errors.
# File lib/sequel/connection_pool.rb, line 94 def make_new(server) begin conn = @db.connect(server) @after_connect.call(conn) if @after_connect rescue Exception=>exception raise Sequel.convert_exception_class(exception, Sequel::DatabaseConnectionError) end raise(Sequel::DatabaseConnectionError, "Connection parameters not valid") unless conn conn end