Class: ActiveRecord::ConnectionAdapters::ConnectionPool

Inherits:
Object
  • Object
show all
Includes:
QueryCache::ConnectionPoolConfiguration, MonitorMixin
Defined in:
lib/active_record/connection_adapters/abstract/connection_pool.rb

Overview

Connection pool base class for managing Active Record database connections.

Introduction

A connection pool synchronizes thread access to a limited number of database connections. The basic idea is that each thread checks out a database connection from the pool, uses that connection, and checks the connection back in. ConnectionPool is completely thread-safe, and will ensure that a connection cannot be used by two threads at the same time, as long as ConnectionPool's contract is correctly followed. It will also handle cases in which there are more threads than connections: if all connections have been checked out, and a thread tries to checkout a connection anyway, then ConnectionPool will wait until some other thread has checked in a connection.

Obtaining (checking out) a connection

Connections can be obtained and used from a connection pool in several ways:

  1. Simply use ActiveRecord::Base.connection as with Active Record 2.1 and earlier (pre-connection-pooling). Eventually, when you're done with the connection(s) and wish it to be returned to the pool, you call ActiveRecord::Base.clear_active_connections!. This will be the default behavior for Active Record when used in conjunction with Action Pack's request handling cycle.

  2. Manually check out a connection from the pool with ActiveRecord::Base.connection_pool.checkout. You are responsible for returning this connection to the pool when finished by calling ActiveRecord::Base.connection_pool.checkin(connection).

  3. Use ActiveRecord::Base.connection_pool.with_connection(&block), which obtains a connection, yields it as the sole argument to the block, and returns it to the pool after the block completes.

Connections in the pool are actually AbstractAdapter objects (or objects compatible with AbstractAdapter's interface).

Options

There are several connection-pooling-related options that you can add to your database connection configuration:

  • pool: maximum number of connections the pool may manage (default 5).

  • idle_timeout: number of seconds that a connection will be kept unused in the pool before it is automatically disconnected (default 300 seconds). Set this to zero to keep connections forever.

  • checkout_timeout: number of seconds to wait for a connection to become available before giving up and raising a timeout error (default 5 seconds).

– Synchronization policy:

  • all public methods can be called outside synchronize

  • access to these instance variables needs to be in synchronize:

    • @connections

    • @now_connecting

  • private methods that require being called in a synchronize blocks are now explicitly documented

Defined Under Namespace

Modules: BiasableQueue Classes: ConnectionLeasingQueue, Queue, Reaper

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from QueryCache::ConnectionPoolConfiguration

#disable_query_cache!, #enable_query_cache!, #query_cache_enabled

Constructor Details

#initialize(spec) ⇒ ConnectionPool

Creates a new ConnectionPool object. spec is a ConnectionSpecification object which describes database connection information (e.g. adapter, host name, username, password, etc), as well as the maximum size for this ConnectionPool.

The default ConnectionPool maximum size is 5.


319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 319

def initialize(spec)
  super()

  @spec = spec

  @checkout_timeout = (spec.config[:checkout_timeout] && spec.config[:checkout_timeout].to_f) || 5
  if @idle_timeout = spec.config.fetch(:idle_timeout, 300)
    @idle_timeout = @idle_timeout.to_f
    @idle_timeout = nil if @idle_timeout <= 0
  end

  # default max pool size to 5
  @size = (spec.config[:pool] && spec.config[:pool].to_i) || 5

  # This variable tracks the cache of threads mapped to reserved connections, with the
  # sole purpose of speeding up the +connection+ method. It is not the authoritative
  # registry of which thread owns which connection. Connection ownership is tracked by
  # the +connection.owner+ attr on each +connection+ instance.
  # The invariant works like this: if there is mapping of <tt>thread => conn</tt>,
  # then that +thread+ does indeed own that +conn+. However, an absence of a such
  # mapping does not mean that the +thread+ doesn't own the said connection. In
  # that case +conn.owner+ attr should be consulted.
  # Access and modification of <tt>@thread_cached_conns</tt> does not require
  # synchronization.
  @thread_cached_conns = Concurrent::Map.new(initial_capacity: @size)

  @connections         = []
  @automatic_reconnect = true

  # Connection pool allows for concurrent (outside the main +synchronize+ section)
  # establishment of new connections. This variable tracks the number of threads
  # currently in the process of independently establishing connections to the DB.
  @now_connecting = 0

  @threads_blocking_new_connections = 0

  @available = ConnectionLeasingQueue.new self

  @lock_thread = false

  # +reaping_frequency+ is configurable mostly for historical reasons, but it could
  # also be useful if someone wants a very low +idle_timeout+.
  reaping_frequency = spec.config.fetch(:reaping_frequency, 60)
  @reaper = Reaper.new(self, reaping_frequency && reaping_frequency.to_f)
  @reaper.run
end

Instance Attribute Details

#automatic_reconnectObject

Returns the value of attribute automatic_reconnect


310
311
312
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 310

def automatic_reconnect
  @automatic_reconnect
end

#checkout_timeoutObject

Returns the value of attribute checkout_timeout


310
311
312
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 310

def checkout_timeout
  @checkout_timeout
end

#connectionsObject (readonly)

Returns the value of attribute connections


311
312
313
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 311

def connections
  @connections
end

#reaperObject (readonly)

Returns the value of attribute reaper


311
312
313
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 311

def reaper
  @reaper
end

#schema_cacheObject

Returns the value of attribute schema_cache


310
311
312
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 310

def schema_cache
  @schema_cache
end

#sizeObject (readonly)

Returns the value of attribute size


311
312
313
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 311

def size
  @size
end

#specObject (readonly)

Returns the value of attribute spec


311
312
313
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 311

def spec
  @spec
end

Instance Method Details

#active_connection?Boolean

Returns true if there is an open connection being used for the current thread.

This method only works for connections that have been obtained through #connection or #with_connection methods. Connections obtained through #checkout will not be detected by #active_connection?

Returns:

  • (Boolean)

388
389
390
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 388

def active_connection?
  @thread_cached_conns[connection_cache_key(Thread.current)]
end

#checkin(conn) ⇒ Object

Check-in a database connection back into the pool, indicating that you no longer need this connection.

conn: an AbstractAdapter object, which was obtained by earlier by calling #checkout on this pool.


529
530
531
532
533
534
535
536
537
538
539
540
541
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 529

def checkin(conn)
  conn.lock.synchronize do
    synchronize do
      remove_connection_from_thread_cache conn

      conn._run_checkin_callbacks do
        conn.expire
      end

      @available.add conn
    end
  end
end

#checkout(checkout_timeout = @checkout_timeout) ⇒ Object

Check-out a database connection from the pool, indicating that you want to use it. You should call #checkin when you no longer need this.

This is done by either returning and leasing existing connection, or by creating a new connection and leasing it.

If all connections are leased and the pool is at capacity (meaning the number of currently leased connections is greater than or equal to the size limit set), an ActiveRecord::ConnectionTimeoutError exception will be raised.

Returns: an AbstractAdapter object.

Raises:

  • ActiveRecord::ConnectionTimeoutError no connection can be obtained from the pool.


520
521
522
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 520

def checkout(checkout_timeout = @checkout_timeout)
  checkout_and_verify(acquire_connection(checkout_timeout))
end

#clear_reloadable_connections(raise_on_acquisition_timeout = true) ⇒ Object

Clears the cache which maps classes and re-connects connections that require reloading.

Raises:

  • ActiveRecord::ExclusiveConnectionTimeoutError if unable to gain ownership of all connections in the pool within a timeout interval (default duration is spec.config[:checkout_timeout] * 2 seconds).


478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 478

def clear_reloadable_connections(raise_on_acquisition_timeout = true)
  with_exclusively_acquired_all_connections(raise_on_acquisition_timeout) do
    synchronize do
      @connections.each do |conn|
        if conn.in_use?
          conn.steal!
          checkin conn
        end
        conn.disconnect! if conn.requires_reloading?
      end
      @connections.delete_if(&:requires_reloading?)
      @available.clear
    end
  end
end

#clear_reloadable_connections!Object

Clears the cache which maps classes and re-connects connections that require reloading.

The pool first tries to gain ownership of all connections. If unable to do so within a timeout interval (default duration is spec.config[:checkout_timeout] * 2 seconds), then the pool forcefully clears the cache and reloads connections without any regard for other connection owning threads.


502
503
504
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 502

def clear_reloadable_connections!
  clear_reloadable_connections(false)
end

#connected?Boolean

Returns true if a connection has already been opened.

Returns:

  • (Boolean)

420
421
422
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 420

def connected?
  synchronize { @connections.any? }
end

#connectionObject

Retrieve the connection associated with the current thread, or call #checkout to obtain one if necessary.

#connection can be called any number of times; the connection is held in a cache keyed by a thread.


379
380
381
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 379

def connection
  @thread_cached_conns[connection_cache_key(@lock_thread || Thread.current)] ||= checkout
end

#discard!Object

Discards all connections in the pool (even if they're currently leased!), along with the pool itself. Any further interaction with the pool (except #spec and #schema_cache) is undefined.

See AbstractAdapter#discard!


461
462
463
464
465
466
467
468
469
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 461

def discard! # :nodoc:
  synchronize do
    return if @connections.nil? # already discarded
    @connections.each do |conn|
      conn.discard!
    end
    @connections = @available = @thread_cached_conns = nil
  end
end

#disconnect(raise_on_acquisition_timeout = true) ⇒ Object

Disconnects all connections in the pool, and clears the pool.

Raises:

  • ActiveRecord::ExclusiveConnectionTimeoutError if unable to gain ownership of all connections in the pool within a timeout interval (default duration is spec.config[:checkout_timeout] * 2 seconds).


430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 430

def disconnect(raise_on_acquisition_timeout = true)
  with_exclusively_acquired_all_connections(raise_on_acquisition_timeout) do
    synchronize do
      @connections.each do |conn|
        if conn.in_use?
          conn.steal!
          checkin conn
        end
        conn.disconnect!
      end
      @connections = []
      @available.clear
    end
  end
end

#disconnect!Object

Disconnects all connections in the pool, and clears the pool.

The pool first tries to gain ownership of all connections. If unable to do so within a timeout interval (default duration is spec.config[:checkout_timeout] * 2 seconds), then the pool is forcefully disconnected without any regard for other connection owning threads.


452
453
454
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 452

def disconnect!
  disconnect(false)
end

#flush(minimum_idle = @idle_timeout) ⇒ Object

Disconnect all connections that have been idle for at least minimum_idle seconds. Connections currently checked out, or that were checked in less than minimum_idle seconds ago, are unaffected.


599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 599

def flush(minimum_idle = @idle_timeout)
  return if minimum_idle.nil?

  idle_connections = synchronize do
    @connections.select do |conn|
      !conn.in_use? && conn.seconds_idle >= minimum_idle
    end.each do |conn|
      conn.lease

      @available.delete conn
      @connections.delete conn
    end
  end

  idle_connections.each do |conn|
    conn.disconnect!
  end
end

#flush!Object

Disconnect all currently idle connections. Connections currently checked out are unaffected.


620
621
622
623
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 620

def flush!
  reap
  flush(-1)
end

#lock_thread=(lock_thread) ⇒ Object


366
367
368
369
370
371
372
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 366

def lock_thread=(lock_thread)
  if lock_thread
    @lock_thread = Thread.current
  else
    @lock_thread = nil
  end
end

#num_waiting_in_queueObject

:nodoc:


625
626
627
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 625

def num_waiting_in_queue # :nodoc:
  @available.num_waiting
end

#reapObject

Recover lost connections for the pool. A lost connection can occur if a programmer forgets to checkin a connection at the end of a thread or a thread dies unexpectedly.


577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 577

def reap
  stale_connections = synchronize do
    @connections.select do |conn|
      conn.in_use? && !conn.owner.alive?
    end.each do |conn|
      conn.steal!
    end
  end

  stale_connections.each do |conn|
    if conn.active?
      conn.reset!
      checkin conn
    else
      remove conn
    end
  end
end

#release_connection(owner_thread = Thread.current) ⇒ Object

Signal that the thread is finished with the current connection. #release_connection releases the connection-thread association and returns the connection to the pool.

This method only works for connections that have been obtained through #connection or #with_connection methods, connections obtained through #checkout will not be automatically released.


399
400
401
402
403
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 399

def release_connection(owner_thread = Thread.current)
  if conn = @thread_cached_conns.delete(connection_cache_key(owner_thread))
    checkin conn
  end
end

#remove(conn) ⇒ Object

Remove a connection from the connection pool. The connection will remain open and active but will no longer be managed by this pool.


545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 545

def remove(conn)
  needs_new_connection = false

  synchronize do
    remove_connection_from_thread_cache conn

    @connections.delete conn
    @available.delete conn

    # @available.any_waiting? => true means that prior to removing this
    # conn, the pool was at its max size (@connections.size == @size).
    # This would mean that any threads stuck waiting in the queue wouldn't
    # know they could checkout_new_connection, so let's do it for them.
    # Because condition-wait loop is encapsulated in the Queue class
    # (that in turn is oblivious to ConnectionPool implementation), threads
    # that are "stuck" there are helpless. They have no way of creating
    # new connections and are completely reliant on us feeding available
    # connections into the Queue.
    needs_new_connection = @available.any_waiting?
  end

  # This is intentionally done outside of the synchronized section as we
  # would like not to hold the main mutex while checking out new connections.
  # Thus there is some chance that needs_new_connection information is now
  # stale, we can live with that (bulk_make_new_connections will make
  # sure not to exceed the pool's @size limit).
  bulk_make_new_connections(1) if needs_new_connection
end

#statObject

Return connection pool's usage statistic Example:

ActiveRecord::Base.connection_pool.stat # => { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }

633
634
635
636
637
638
639
640
641
642
643
644
645
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 633

def stat
  synchronize do
    {
      size: size,
      connections: @connections.size,
      busy: @connections.count { |c| c.in_use? && c.owner.alive? },
      dead: @connections.count { |c| c.in_use? && !c.owner.alive? },
      idle: @connections.count { |c| !c.in_use? },
      waiting: num_waiting_in_queue,
      checkout_timeout: checkout_timeout
    }
  end
end

#with_connectionObject

If a connection obtained through #connection or #with_connection methods already exists yield it to the block. If no such connection exists checkout a connection, yield it to the block, and checkin the connection when finished.


409
410
411
412
413
414
415
416
417
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 409

def with_connection
  unless conn = @thread_cached_conns[connection_cache_key(Thread.current)]
    conn = connection
    fresh_connection = true
  end
  yield conn
ensure
  release_connection if fresh_connection
end