Class: Sequel::ThreadedConnectionPool

Inherits:
ConnectionPool show all
Defined in:
lib/sequel/connection_pool/threaded.rb

Overview

A connection pool allowing multi-threaded access to a pool of connections. This is the default connection pool used by Sequel.

Direct Known Subclasses

ShardedThreadedConnectionPool

Constant Summary collapse

USE_WAITER =
true

Constants inherited from ConnectionPool

ConnectionPool::OPTS, ConnectionPool::POOL_CLASS_MAP

Instance Attribute Summary collapse

Attributes inherited from ConnectionPool

#after_connect, #db

Instance Method Summary collapse

Methods inherited from ConnectionPool

#servers

Methods included from ConnectionPool::ClassMethods

#get_pool

Constructor Details

#initialize(db, opts = OPTS) ⇒ ThreadedConnectionPool

The following additional options are respected:

:max_connections

The maximum number of connections the connection pool will open (default 4)

:pool_timeout

The amount of seconds to wait to acquire a connection before raising a PoolTimeoutError (default 5)

Raises:


25
26
27
28
29
30
31
32
33
34
35
# File 'lib/sequel/connection_pool/threaded.rb', line 25

def initialize(db, opts = OPTS)
  super
  @max_size = Integer(opts[:max_connections] || 4)
  raise(Sequel::Error, ':max_connections must be positive') if @max_size < 1
  @mutex = Mutex.new  
  @connection_handling = opts[:connection_handling]
  @available_connections = []
  @allocated = {}
  @timeout = Float(opts[:pool_timeout] || 5)
  @waiter = ConditionVariable.new
end

Instance Attribute Details

#allocatedObject (readonly)

A hash with thread keys and connection values for currently allocated connections.


18
19
20
# File 'lib/sequel/connection_pool/threaded.rb', line 18

def allocated
  @allocated
end

#available_connectionsObject (readonly)

An array of connections that are available for use by the pool.


14
15
16
# File 'lib/sequel/connection_pool/threaded.rb', line 14

def available_connections
  @available_connections
end

#max_sizeObject (readonly)

The maximum number of connections this pool will create (per shard/server if sharding).


11
12
13
# File 'lib/sequel/connection_pool/threaded.rb', line 11

def max_size
  @max_size
end

Instance Method Details

#all_connectionsObject

Yield all of the available connections, and the one currently allocated to this thread. This will not yield connections currently allocated to other threads, as it is not safe to operate on them. This holds the mutex while it is yielding all of the available connections, which means that until the method's block returns, the pool is locked.


42
43
44
45
46
47
48
49
# File 'lib/sequel/connection_pool/threaded.rb', line 42

def all_connections
  hold do |c|
    sync do
      yield c
      @available_connections.each{|conn| yield conn}
    end
  end
end

#disconnect(opts = OPTS) ⇒ Object

Removes all connections currently available, optionally yielding each connection to the given block. This method has the effect of disconnecting from the database, assuming that no connections are currently being used. If you want to be able to disconnect connections that are currently in use, use the ShardedThreadedConnectionPool, which can do that. This connection pool does not, for performance reasons. To use the sharded pool, pass the servers: {} option when connecting to the database.

Once a connection is requested using #hold, the connection pool creates new connections to the database.


61
62
63
64
65
66
67
68
69
# File 'lib/sequel/connection_pool/threaded.rb', line 61

def disconnect(opts=OPTS)
  conns = nil
  sync do
    conns = @available_connections.dup
    @available_connections.clear
    @waiter.signal
  end
  conns.each{|conn| disconnect_connection(conn)}
end

#hold(server = nil) ⇒ Object

Chooses the first available connection, or if none are available, creates a new connection. Passes the connection to the supplied block:

pool.hold {|conn| conn.execute('DROP TABLE posts')}

Pool#hold is re-entrant, meaning it can be called recursively in the same thread without blocking.

If no connection is immediately available and the pool is already using the maximum number of connections, Pool#hold will block until a connection is available or the timeout expires. If the timeout expires before a connection can be acquired, a Sequel::PoolTimeout is raised.


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/sequel/connection_pool/threaded.rb', line 84

def hold(server=nil)
  t = Thread.current
  if conn = owned_connection(t)
    return yield(conn)
  end
  begin
    conn = acquire(t)
    yield conn
  rescue Sequel::DatabaseDisconnectError, *@error_classes => e
    if disconnect_error?(e)
      oconn = conn
      conn = nil
      disconnect_connection(oconn) if oconn
      sync do 
        @allocated.delete(t)
        @waiter.signal
      end
    end
    raise
  ensure
    sync{release(t)} if conn
  end
end

#pool_typeObject


108
109
110
# File 'lib/sequel/connection_pool/threaded.rb', line 108

def pool_type
  :threaded
end

#sizeObject

The total number of connections opened, either available or allocated. The calling code should not have the mutex before calling this.


114
115
116
# File 'lib/sequel/connection_pool/threaded.rb', line 114

def size
  @mutex.synchronize{_size}
end