Class: Sequel::ConnectionPool
- Extended by:
- ClassMethods
- Defined in:
- lib/sequel/connection_pool.rb
Overview
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, the Symbol 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.
Direct Known Subclasses
ShardedSingleConnectionPool, SingleConnectionPool, ThreadedConnectionPool
Defined Under Namespace
Modules: ClassMethods
Constant Summary collapse
- OPTS =
Sequel::OPTS
- POOL_CLASS_MAP =
{ :threaded => :ThreadedConnectionPool, :single => :SingleConnectionPool, :sharded_threaded => :ShardedThreadedConnectionPool, :sharded_single => :ShardedSingleConnectionPool }.freeze
Instance Attribute Summary collapse
-
#after_connect ⇒ Object
The after_connect proc used for this pool.
-
#connect_sqls ⇒ Object
An array of sql strings to execute on each new connection.
-
#db ⇒ Object
The Sequel::Database object tied to this connection pool.
Instance Method Summary collapse
-
#initialize(db, opts = OPTS) ⇒ ConnectionPool
constructor
Instantiates a connection pool with the given options.
-
#servers ⇒ Object
An array of symbols for all shards/servers, which is a single
:default
by default.
Methods included from ClassMethods
Constructor Details
#initialize(db, opts = OPTS) ⇒ ConnectionPool
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
-
A callable object called after each new connection is made, with the connection object (and server argument if the callable accepts 2 arguments), useful for customizations that you want to apply to all connections.
- :connect_sqls
-
An array of sql strings to execute on each new connection, after :after_connect runs.
93 94 95 96 97 98 |
# File 'lib/sequel/connection_pool.rb', line 93 def initialize(db, opts=OPTS) @db = db @after_connect = opts[:after_connect] @connect_sqls = opts[:connect_sqls] @error_classes = db.send(:database_error_classes).dup.freeze end |
Instance Attribute Details
#after_connect ⇒ Object
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.
77 78 79 |
# File 'lib/sequel/connection_pool.rb', line 77 def after_connect @after_connect end |
#connect_sqls ⇒ Object
An array of sql strings to execute on each new connection.
80 81 82 |
# File 'lib/sequel/connection_pool.rb', line 80 def connect_sqls @connect_sqls end |
#db ⇒ Object
The Sequel::Database object tied to this connection pool.
83 84 85 |
# File 'lib/sequel/connection_pool.rb', line 83 def db @db end |
Instance Method Details
#servers ⇒ Object
An array of symbols for all shards/servers, which is a single :default
by default.
101 102 103 |
# File 'lib/sequel/connection_pool.rb', line 101 def servers [:default] end |