Class: ActiveRecord::ConnectionAdapters::ConnectionHandler

Inherits:
Object
  • Object
show all
Defined in:
activerecord/lib/active_record/connection_adapters/abstract/connection_handler.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 connection specification name to the handler, in order to look up the correct connection pool.

Defined Under Namespace

Classes: StringConnectionName

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConnectionHandler

Returns a new instance of ConnectionHandler.



75
76
77
78
79
80
81
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 75

def initialize
  # These caches are keyed by pool_config.connection_name (PoolConfig#connection_name).
  @connection_name_to_pool_manager = Concurrent::Map.new(initial_capacity: 2)

  # Backup finalizer: if the forked child skipped Kernel#fork the early discard has not occurred
  ObjectSpace.define_finalizer self, FINALIZER
end

Instance Method Details

#active_connections?(role = nil) ⇒ Boolean

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

Returns:

  • (Boolean) 


170
171
172
173
174
175
176
177
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 170

def active_connections?(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
  end

  each_connection_pool(role).any?(&:active_connection?)
end

#all_connection_pools ⇒ Object 



95
96
97
98
99
100
101
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 95

def all_connection_pools
  ActiveRecord.deprecator.warn(<<-MSG.squish)
    The `all_connection_pools` method is deprecated in favor of `connection_pool_list`.
    Call `connection_pool_list(:all)` to get the same behavior as `all_connection_pools`.
  MSG
  connection_name_to_pool_manager.values.flat_map { |m| m.pool_configs.map(&:pool) }
end

#clear_active_connections!(role = nil) ⇒ 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.



182
183
184
185
186
187
188
189
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 182

def clear_active_connections!(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
  end

  each_connection_pool(role).each(&:release_connection)
end

#clear_all_connections!(role = nil) ⇒ Object 



203
204
205
206
207
208
209
210
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 203

def clear_all_connections!(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
  end

  each_connection_pool(role).each(&:disconnect!)
end

#clear_reloadable_connections!(role = nil) ⇒ Object

Clears the cache which maps classes.

See ConnectionPool#clear_reloadable_connections! for details.



194
195
196
197
198
199
200
201
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 194

def clear_reloadable_connections!(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
  end

  each_connection_pool(role).each(&:clear_reloadable_connections!)
end

#connected?(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard) ⇒ Boolean

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

Returns:

  • (Boolean) 


248
249
250
251
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 248

def connected?(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard)
  pool = retrieve_connection_pool(connection_name, role: role, shard: shard)
  pool && pool.connected?
end

#connection_pool_list(role = nil) ⇒ Object Also known as: connection_pools

Returns the pools for a connection handler and given role. If :all is passed, all pools belonging to the connection handler will be returned.



105
106
107
108
109
110
111
112
113
114
115
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 105

def connection_pool_list(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
    connection_name_to_pool_manager.values.flat_map { |m| m.pool_configs(role).map(&:pool) }
  elsif role == :all
    connection_name_to_pool_manager.values.flat_map { |m| m.pool_configs.map(&:pool) }
  else
    connection_name_to_pool_manager.values.flat_map { |m| m.pool_configs(role).map(&:pool) }
  end
end

#connection_pool_names ⇒ Object

:nodoc:



91
92
93
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 91

def connection_pool_names # :nodoc:
  connection_name_to_pool_manager.keys
end

#each_connection_pool(role = nil, &block) ⇒ Object

:nodoc:



118
119
120
121
122
123
124
125
126
127
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 118

def each_connection_pool(role = nil, &block) # :nodoc:
  role = nil if role == :all
  return enum_for(__method__, role) unless block_given?

  connection_name_to_pool_manager.each_value do |manager|
    manager.each_pool_config(role) do |pool_config|
      yield pool_config.pool
    end
  end
end

#establish_connection(config, owner_name: Base, role: ActiveRecord::Base.current_role, shard: Base.current_shard) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 129

def establish_connection(config, owner_name: Base, role: ActiveRecord::Base.current_role, shard: Base.current_shard)
  owner_name = determine_owner_name(owner_name, config)

  pool_config = resolve_pool_config(config, owner_name, role, shard)
  db_config = pool_config.db_config

  pool_manager = set_pool_manager(pool_config.connection_name)

  # If there is an existing pool with the same values as the pool_config
  # don't remove the connection. Connections should only be removed if we are
  # establishing a connection on a class that is already connected to a different
  # configuration.
  existing_pool_config = pool_manager.get_pool_config(role, shard)

  if existing_pool_config && existing_pool_config.db_config == db_config
    # Update the pool_config's connection class if it differs. This is used
    # for ensuring that ActiveRecord::Base and the primary_abstract_class use
    # the same pool. Without this granular swapping will not work correctly.
    if owner_name.primary_class? && (existing_pool_config.connection_class != owner_name)
      existing_pool_config.connection_class = owner_name
    end

    existing_pool_config.pool
  else
    disconnect_pool_from_pool_manager(pool_manager, role, shard)
    pool_manager.set_pool_config(role, shard, pool_config)

    payload = {
      connection_name: pool_config.connection_name,
      shard: shard,
      config: db_config.configuration_hash
    }

    ActiveSupport::Notifications.instrumenter.instrument("!connection.active_record", payload) do
      pool_config.pool
    end
  end
end

#flush_idle_connections!(role = nil) ⇒ Object

Disconnects all currently idle connections.

See ConnectionPool#flush! for details.



215
216
217
218
219
220
221
222
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 215

def flush_idle_connections!(role = nil)
  if role.nil?
    deprecation_for_pool_handling(__method__)
    role = ActiveRecord::Base.current_role
  end

  each_connection_pool(role).each(&:flush!)
end

#prevent_writes ⇒ Object

:nodoc:



83
84
85
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 83

def prevent_writes # :nodoc:
  ActiveSupport::IsolatedExecutionState[:active_record_prevent_writes]
end

#prevent_writes=(prevent_writes) ⇒ Object

:nodoc:



87
88
89
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 87

def prevent_writes=(prevent_writes) # :nodoc:
  ActiveSupport::IsolatedExecutionState[:active_record_prevent_writes] = prevent_writes
end

#remove_connection_pool(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard) ⇒ Object 



253
254
255
256
257
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 253

def remove_connection_pool(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard)
  if pool_manager = get_pool_manager(connection_name)
    disconnect_pool_from_pool_manager(pool_manager, role, shard)
  end
end

#retrieve_connection(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard) ⇒ 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).



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 228

def retrieve_connection(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard) # :nodoc:
  pool = retrieve_connection_pool(connection_name, role: role, shard: shard)

  unless pool
    if shard != ActiveRecord::Base.default_shard
      message = "No connection pool for '#{connection_name}' found for the '#{shard}' shard."
    elsif role != ActiveRecord::Base.default_role
      message = "No connection pool for '#{connection_name}' found for the '#{role}' role."
    else
      message = "No connection pool for '#{connection_name}' found."
    end

    raise ConnectionNotEstablished, message
  end

  pool.connection
end

#retrieve_connection_pool(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard) ⇒ Object

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



262
263
264
265
 
# File 'activerecord/lib/active_record/connection_adapters/abstract/connection_handler.rb', line 262

def retrieve_connection_pool(connection_name, role: ActiveRecord::Base.current_role, shard: ActiveRecord::Base.current_shard)
  pool_config = get_pool_manager(connection_name)&.get_pool_config(role, shard)
  pool_config&.pool
end