class Sequel::ConnectionPool
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(Database,
Hash
) -
Initialize using the passed
Sequel::Database
object and options hash. - hold(
Symbol
, &block) -
Yield a connection object (obtained from calling the block passed to
initialize
) to the current block. For sharded connection pools, theSymbol
passed is the shard/server to use. - disconnect(
Symbol
) -
Disconnect the connection object. 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.
- max_size
-
an integer representing the maximum size of the connection pool, or the maximum size per 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.
Constants
- OPTS
- POOL_CLASS_MAP
Attributes
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. Deprecated.
An array of sql strings to execute on each new connection. Deprecated.
The Sequel::Database
object tied to this connection pool.
Public Class Methods
Instantiates a connection pool with the given Database and options.
# File lib/sequel/connection_pool.rb 101 def initialize(db, opts=OPTS) # SEQUEL6: Remove second argument, always use db.opts 102 @db = db 103 @use_old_connect_api = false # SEQUEL6: Remove 104 @after_connect = opts[:after_connect] # SEQUEL6: Remove 105 @connect_sqls = opts[:connect_sqls] # SEQUEL6: Remove 106 @error_classes = db.send(:database_error_classes).dup.freeze 107 end
Public Instance Methods
Override the after_connect
proc for the connection pool. Deprecated. Disables support for shard-specific :after_connect and :connect_sqls if used.
# File lib/sequel/connection_pool.rb 82 def after_connect=(v) # SEQUEL6: Remove 83 @use_old_connect_api = true 84 @after_connect = v 85 end
Override the connect_sqls
for the connection pool. Deprecated. Disables support for shard-specific :after_connect and :connect_sqls if used.
# File lib/sequel/connection_pool.rb 92 def connect_sqls=(v) # SEQUEL6: Remove 93 @use_old_connect_api = true 94 @connect_sqls = v 95 end
An array of symbols for all shards/servers, which is a single :default
by default.
# File lib/sequel/connection_pool.rb 110 def servers 111 [:default] 112 end
Private Instance Methods
Remove the connection from the pool. For threaded connections, this should be called without the mutex, because the disconnection may block.
# File lib/sequel/connection_pool.rb 118 def disconnect_connection(conn) 119 db.disconnect_connection(conn) 120 end
Whether the given exception is a disconnect exception.
# File lib/sequel/connection_pool.rb 123 def disconnect_error?(exception) 124 exception.is_a?(Sequel::DatabaseDisconnectError) || db.send(:disconnect_error?, exception, OPTS) 125 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 129 def make_new(server) 130 begin 131 if @use_old_connect_api 132 # SEQUEL6: Remove block 133 conn = @db.connect(server) 134 135 if ac = @after_connect 136 if ac.arity == 2 137 ac.call(conn, server) 138 else 139 ac.call(conn) 140 end 141 end 142 143 if cs = @connect_sqls 144 cs.each do |sql| 145 db.send(:log_connection_execute, conn, sql) 146 end 147 end 148 149 conn 150 else 151 @db.new_connection(server) 152 end 153 rescue Exception=>exception 154 raise Sequel.convert_exception_class(exception, Sequel::DatabaseConnectionError) 155 end || raise(Sequel::DatabaseConnectionError, "Connection parameters not valid") 156 end