Class: ActiveRecord::ConnectionAdapters::ConnectionHandler

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/connection_adapters/abstract/connection_pool.rb

Overview

ConnectionHandler is a collection of ConnectionPool objects. It is used for keeping separate connection pools that connect to different databases.

For example, suppose that you have 5 models, with the following hierarchy:

class Author < ActiveRecord::Base
end

class BankAccount < ActiveRecord::Base
end

class Book < ActiveRecord::Base
  establish_connection :library_db
end

class ScaryBook < Book
end

class GoodBook < Book
end

And a database.yml that looked like this:

development:
  database: my_application
  host: localhost

library_db:
  database: library
  host: some.library.org

Your primary database in the development environment is “my_application” but the Book model connects to a separate database called “library_db” (this can even be a database on a different machine).

Book, ScaryBook and GoodBook will all use the same connection pool to “library_db” while Author, BankAccount, and any other models you create will use the default connection pool to “my_application”.

The various connection pools are managed by a single instance of ConnectionHandler accessible via ActiveRecord::Base.connection_handler. All Active Record models use this handler to determine the connection pool that they should use.

The ConnectionHandler class is not coupled with the Active models, as it has no knowledge about the model. The model needs to pass a specification name to the handler, in order to look up the correct connection pool.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConnectionHandler

Returns a new instance of ConnectionHandler.


928
929
930
931
932
933
934
935
936
937
938
939
940
941
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 928

def initialize
  # These caches are keyed by spec.name (ConnectionSpecification#name).
  @owner_to_pool = Concurrent::Map.new(initial_capacity: 2) do |h, k|
    # Discard the parent's connection pools immediately; we have no need
    # of them
    ConnectionHandler.discard_unowned_pools(h)

    h[k] = Concurrent::Map.new(initial_capacity: 2)
  end

  # Backup finalizer: if the forked child never needed a pool, the above
  # early discard has not occurred
  ObjectSpace.define_finalizer self, ConnectionHandler.unowned_pool_finalizer(@owner_to_pool)
end

Class Method Details

.discard_unowned_pools(pid_map) ⇒ Object

:nodoc:


922
923
924
925
926
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 922

def self.discard_unowned_pools(pid_map) # :nodoc:
  pid_map.each do |pid, pools|
    pools.values.compact.each(&:discard!) unless pid == Process.pid
  end
end

.unowned_pool_finalizer(pid_map) ⇒ Object

:nodoc:


916
917
918
919
920
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 916

def self.unowned_pool_finalizer(pid_map) # :nodoc:
  lambda do |_|
    discard_unowned_pools(pid_map)
  end
end

Instance Method Details

#active_connections?Boolean

Returns true if there are any active connections among the connection pools that the ConnectionHandler is managing.

Returns:

  • (Boolean)

972
973
974
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 972

def active_connections?
  connection_pool_list.any?(&:active_connection?)
end

#clear_active_connections!Object

Returns any connections in use by the current thread back to the pool, and also returns connections to the pool cached by threads that are no longer alive.


979
980
981
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 979

def clear_active_connections!
  connection_pool_list.each(&:release_connection)
end

#clear_all_connections!Object


990
991
992
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 990

def clear_all_connections!
  connection_pool_list.each(&:disconnect!)
end

#clear_reloadable_connections!Object

Clears the cache which maps classes.

See ConnectionPool#clear_reloadable_connections! for details.


986
987
988
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 986

def clear_reloadable_connections!
  connection_pool_list.each(&:clear_reloadable_connections!)
end

#connected?(spec_name) ⇒ Boolean

Returns true if a connection that's accessible to this class has already been opened.

Returns:

  • (Boolean)

1013
1014
1015
1016
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 1013

def connected?(spec_name)
  conn = retrieve_connection_pool(spec_name)
  conn && conn.connected?
end

#connection_pool_listObject Also known as: connection_pools


943
944
945
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 943

def connection_pool_list
  owner_to_pool.values.compact
end

#establish_connection(config) ⇒ Object


948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 948

def establish_connection(config)
  resolver = ConnectionSpecification::Resolver.new(Base.configurations)
  spec = resolver.spec(config)

  remove_connection(spec.name)

  message_bus = ActiveSupport::Notifications.instrumenter
  payload = {
    connection_id: object_id
  }
  if spec
    payload[:spec_name] = spec.name
    payload[:config] = spec.config
  end

  message_bus.instrument("!connection.active_record", payload) do
    owner_to_pool[spec.name] = ConnectionAdapters::ConnectionPool.new(spec)
  end

  owner_to_pool[spec.name]
end

#flush_idle_connections!Object

Disconnects all currently idle connections.

See ConnectionPool#flush! for details.


997
998
999
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 997

def flush_idle_connections!
  connection_pool_list.each(&:flush!)
end

#remove_connection(spec_name) ⇒ Object

Remove the connection for this class. This will close the active connection and the defined connection (if they exist). The result can be used as an argument for #establish_connection, for easily re-establishing the connection.


1022
1023
1024
1025
1026
1027
1028
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 1022

def remove_connection(spec_name)
  if pool = owner_to_pool.delete(spec_name)
    pool.automatic_reconnect = false
    pool.disconnect!
    pool.spec.config
  end
end

#retrieve_connection(spec_name) ⇒ Object

Locate the connection of the nearest super class. This can be an active or defined connection: if it is the latter, it will be opened and set as the active connection for the class it was defined for (not necessarily the current class).


1005
1006
1007
1008
1009
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 1005

def retrieve_connection(spec_name) #:nodoc:
  pool = retrieve_connection_pool(spec_name)
  raise ConnectionNotEstablished, "No connection pool with '#{spec_name}' found." unless pool
  pool.connection
end

#retrieve_connection_pool(spec_name) ⇒ Object

Retrieving the connection pool happens a lot, so we cache it in @owner_to_pool. This makes retrieving the connection pool O(1) once the process is warm. When a connection is established or removed, we invalidate the cache.


1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
# File 'lib/active_record/connection_adapters/abstract/connection_pool.rb', line 1033

def retrieve_connection_pool(spec_name)
  owner_to_pool.fetch(spec_name) do
    # Check if a connection was previously established in an ancestor process,
    # which may have been forked.
    if ancestor_pool = pool_from_any_process_for(spec_name)
      # A connection was established in an ancestor process that must have
      # subsequently forked. We can't reuse the connection, but we can copy
      # the specification and establish a new connection with it.
      establish_connection(ancestor_pool.spec.to_hash).tap do |pool|
        pool.schema_cache = ancestor_pool.schema_cache if ancestor_pool.schema_cache
      end
    else
      owner_to_pool[spec_name] = nil
    end
  end
end