Class: Sequel::SingleThreadedPool

Inherits:
Object
  • Object
show all
Defined in:
lib/sequel/connection_pool.rb

Overview

A SingleThreadedPool acts as a replacement for a ConnectionPool for use in single-threaded applications. ConnectionPool imposes a substantial performance penalty, so SingleThreadedPool is used to gain some speed.

Note that using a single threaded pool with some adapters can cause errors in certain cases, see Sequel.single_threaded=.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}, &block) ⇒ SingleThreadedPool

Initializes the instance with the supplied block as the connection_proc.

The single threaded pool takes the following options:

  • :pool_convert_exceptions - Whether to convert non-StandardError based exceptions to RuntimeError exceptions (default true)



222
223
224
225
226
227
 
# File 'lib/sequel/connection_pool.rb', line 222

def initialize(opts={}, &block)
  @connection_proc = block
  @disconnection_proc = opts[:disconnection_proc]
  @conns = {}
  @convert_exceptions = opts.include?(:pool_convert_exceptions) ? opts[:pool_convert_exceptions] : true
end

Instance Attribute Details

#connection_proc=(value) ⇒ Object (writeonly)

The proc used to create a new database connection



211
212
213
 
# File 'lib/sequel/connection_pool.rb', line 211

def connection_proc=(value)
  @connection_proc = value
end

#disconnection_proc ⇒ Object

The proc used to disconnect a database connection.



214
215
216
 
# File 'lib/sequel/connection_pool.rb', line 214

def disconnection_proc
  @disconnection_proc
end

Instance Method Details

#conn(server = :default) ⇒ Object

The connection for the given server.



230
231
232
 
# File 'lib/sequel/connection_pool.rb', line 230

def conn(server=:default)
  @conns[server]
end

#disconnect(&block) ⇒ Object

Disconnects from the database. Once a connection is requested using #hold, the connection is reestablished.



253
254
255
256
257
 
# File 'lib/sequel/connection_pool.rb', line 253

def disconnect(&block)
  block ||= @disconnection_proc
  @conns.values.each{|conn| block.call(conn) if block}
  @conns = {}
end

#hold(server = :default) ⇒ Object

Yields the connection to the supplied block for the given server. This method simulates the ConnectionPool#hold API.



236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/sequel/connection_pool.rb', line 236

def hold(server=:default)
  begin
    begin
      yield(c = (@conns[server] ||= @connection_proc.call(server)))
    rescue Sequel::DatabaseDisconnectError => dde
      @conns.delete(server)
      @disconnection_proc.call(c) if @disconnection_proc
      raise
    end
  rescue Exception => e
    # if the error is not a StandardError it is converted into RuntimeError.
    raise(@convert_exceptions && !e.is_a?(StandardError) ? RuntimeError.new(e.message) : e)
  end
end