Class: Sequel::ConnectionPool

Inherits:
Object
  • Object
show all
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(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.

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

DEFAULT_SERVER =

The default server to use

:default
CONNECTION_POOL_MAP =

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ClassMethods

get_pool

Constructor Details

#initialize(opts = {}, &block) ⇒ 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

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.

Raises:



78
79
80
81
82
 
# File 'lib/sequel/connection_pool.rb', line 78

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

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.



63
64
65
 
# File 'lib/sequel/connection_pool.rb', line 63

def after_connect
  @after_connect
end

#disconnection_proc ⇒ Object

The disconnect_proc used for the pool. This is called with each connection that is disconnected, usually to clean up related resources.



67
68
69
 
# File 'lib/sequel/connection_pool.rb', line 67

def disconnection_proc
  @disconnection_proc
end

Instance Method Details

#created_count(*args) ⇒ Object

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



85
86
87
 
# File 'lib/sequel/connection_pool.rb', line 85

def created_count(*args)
  size(*args)
end

#servers ⇒ Object

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



90
91
92
 
# File 'lib/sequel/connection_pool.rb', line 90

def servers
  [DEFAULT_SERVER]
end