Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

Inherits:
Object
  • Object
show all
Includes:
DatabaseLimits, DatabaseStatements, QueryCache, Quoting, Savepoints, SchemaStatements, ActiveSupport::Callbacks
Defined in:
lib/active_record/connection_adapters/abstract_adapter.rb

Overview

Active Record Abstract Adapter

Active Record supports multiple database systems. AbstractAdapter and related classes form the abstraction layer which makes this possible. An AbstractAdapter represents a connection to a database, and provides an abstract interface for database-specific functionality such as establishing a connection, escaping values, building the right SQL fragments for :offset and :limit options, etc.

All the concrete database adapters follow the interface laid down in this class. ActiveRecord::Base.lease_connection returns an AbstractAdapter object, which you can use.

Most of the methods in the adapter are useful during migrations. Most notably, the instance methods provided by SchemaStatements are very useful.

Defined Under Namespace

Classes: Version

Constant Summary collapse

ADAPTER_NAME = 
"Abstract"
SIMPLE_INT = 
/\A\d+\z/
COMMENT_REGEX = 
%r{(?:--.*\n)|/\*(?:[^*]|\*[^/])*\*/}
TYPE_MAP = 
Type::TypeMap.new.tap { |m| initialize_type_map(m) }
EXTENDED_TYPE_MAPS = 
Concurrent::Map.new

Constants included from QueryCache

QueryCache::DEFAULT_SIZE

Instance Attribute Summary collapse

Attributes included from QueryCache

#query_cache

Attributes included from DatabaseStatements

#transaction_manager

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Savepoints

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

Methods included from QueryCache

#cache, #clear_query_cache, dirties_query_cache, #disable_query_cache!, #enable_query_cache!, included, #query_cache_enabled, #select_all, #uncached

Methods included from DatabaseLimits

#index_name_length, #max_identifier_length, #table_alias_length, #table_name_length

Methods included from Quoting

#cast_bound_value, #lookup_cast_type_from_column, #quote, #quote_column_name, #quote_default_expression, #quote_string, #quote_table_name, #quote_table_name_for_assignment, #quoted_binary, #quoted_date, #quoted_false, #quoted_time, #quoted_true, #sanitize_as_sql_comment, #type_cast, #unquoted_false, #unquoted_true

Methods included from DatabaseStatements

#add_transaction_record, #begin_db_transaction, #begin_deferred_transaction, #begin_isolated_db_transaction, #cacheable_query, #commit_db_transaction, #default_sequence_name, #delete, #empty_insert_statement_value, #exec_delete, #exec_insert, #exec_insert_all, #exec_query, #exec_restart_db_transaction, #exec_rollback_db_transaction, #exec_update, #execute, #explain, #high_precision_current_timestamp, #insert, #insert_fixture, #insert_fixtures_set, #internal_exec_query, #mark_transaction_written_if_write, #query, #query_value, #query_values, #raw_exec_query, #reset_isolation_level, #reset_sequence!, #reset_transaction, #restart_db_transaction, #rollback_db_transaction, #rollback_to_savepoint, #sanitize_limit, #select_all, #select_one, #select_rows, #select_value, #select_values, #to_sql, #transaction, #transaction_isolation_levels, #transaction_open?, #truncate, #truncate_tables, #update, #with_yaml_fallback, #write_query?

Methods included from SchemaStatements

#add_check_constraint, #add_column, #add_columns, #add_foreign_key, #add_index, #add_index_options, #add_reference, #add_timestamps, #assume_migrated_upto_version, #build_add_column_definition, #build_change_column_default_definition, #build_create_index_definition, #build_create_join_table_definition, #build_create_table_definition, #bulk_change_table, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table, #change_table_comment, #check_constraint_exists?, #check_constraint_options, #check_constraints, #column_exists?, #columns, #columns_for_distinct, #create_join_table, #create_schema_dumper, #create_table, #data_source_exists?, #data_sources, #distinct_relation_for_primary_key, #drop_join_table, #drop_table, #dump_schema_information, #foreign_key_column_for, #foreign_key_exists?, #foreign_key_options, #foreign_keys, #index_algorithm, #index_exists?, #index_name, #index_name_exists?, #indexes, #internal_string_options_for_primary_key, #max_index_name_size, #native_database_types, #options_include_default?, #primary_key, #quoted_columns_for_index, #remove_check_constraint, #remove_column, #remove_columns, #remove_constraint, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #rename_column, #rename_index, #rename_table, #schema_creation, #table_alias_for, #table_comment, #table_exists?, #table_options, #tables, #type_to_sql, #update_table_definition, #use_foreign_keys?, #valid_column_definition_options, #valid_primary_key_options, #valid_table_definition_options, #view_exists?, #views

Constructor Details

#initialize(config_or_deprecated_connection, deprecated_logger = nil, deprecated_connection_options = nil, deprecated_config = nil) ⇒ AbstractAdapter

:nodoc:



125
126
127
128
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
167
168
169
170
171
172
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 125

def initialize(config_or_deprecated_connection, deprecated_logger = nil, deprecated_connection_options = nil, deprecated_config = nil) # :nodoc:
  super()

  @raw_connection = nil
  @unconfigured_connection = nil

  if config_or_deprecated_connection.is_a?(Hash)
    @config = config_or_deprecated_connection.symbolize_keys
    @logger = ActiveRecord::Base.logger

    if deprecated_logger || deprecated_connection_options || deprecated_config
      raise ArgumentError, "when initializing an Active Record adapter with a config hash, that should be the only argument"
    end
  else
    # Soft-deprecated for now; we'll probably warn in future.

    @unconfigured_connection = config_or_deprecated_connection
    @logger = deprecated_logger || ActiveRecord::Base.logger
    if deprecated_config
      @config = (deprecated_config || {}).symbolize_keys
      @connection_parameters = deprecated_connection_options
    else
      @config = (deprecated_connection_options || {}).symbolize_keys
      @connection_parameters = nil
    end
  end

  @owner = nil
  @instrumenter = ActiveSupport::Notifications.instrumenter
  @pool = ActiveRecord::ConnectionAdapters::NullPool.new
  @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  @visitor = arel_visitor
  @statements = build_statement_pool
  self.lock_thread = nil

  @prepared_statements = !ActiveRecord.disable_prepared_statements && self.class.type_cast_config_to_boolean(
    @config.fetch(:prepared_statements) { default_prepared_statements }
  )

  @advisory_locks_enabled = self.class.type_cast_config_to_boolean(
    @config.fetch(:advisory_locks, true)
  )

  @default_timezone = self.class.validate_default_timezone(@config[:default_timezone])

  @raw_connection_dirty = false
  @verified = false
end

Instance Attribute Details

#lock ⇒ Object (readonly)

Returns the value of attribute lock.



44
45
46
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 44

def lock
  @lock
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



44
45
46
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 44

def logger
  @logger
end

#owner ⇒ Object (readonly) Also known as: in_use?

Returns the value of attribute owner.



44
45
46
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 44

def owner
  @owner
end

#pool ⇒ Object

Returns the value of attribute pool.



43
44
45
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 43

def pool
  @pool
end

#visitor ⇒ Object (readonly)

Returns the value of attribute visitor.



44
45
46
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 44

def visitor
  @visitor
end

Class Method Details

.build_read_query_regexp(*parts) ⇒ Object

:nodoc:



86
87
88
89
90
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 86

def self.build_read_query_regexp(*parts) # :nodoc:
  parts += DEFAULT_READ_QUERY
  parts = parts.map { |part| /#{part}/i }
  /\A(?:[(\s]|#{COMMENT_REGEX})*#{Regexp.union(*parts)}/
end

.database_exists?(config) ⇒ Boolean

Does the database for this adapter exist?

Returns:

  • (Boolean) 


360
361
362
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 360

def self.database_exists?(config)
  new(config).database_exists?
end

.dbconsole(config, options = {}) ⇒ Object

Opens a database console session.

Raises:

  • (NotImplementedError) 


121
122
123
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 121

def self.dbconsole(config, options = {})
  raise NotImplementedError
end

.extended_type_map(default_timezone:) ⇒ Object

:nodoc:



876
877
878
879
880
881
882
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 876

def extended_type_map(default_timezone:) # :nodoc:
  Type::TypeMap.new(self::TYPE_MAP).tap do |m|
    register_class_with_precision m, %r(\A[^\(]*time)i, Type::Time, timezone: default_timezone
    register_class_with_precision m, %r(\A[^\(]*datetime)i, Type::DateTime, timezone: default_timezone
    m.alias_type %r(\A[^\(]*timestamp)i, "datetime"
  end
end

.find_cmd_and_exec(commands, *args) ⇒ Object

:doc:



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 92

def self.find_cmd_and_exec(commands, *args) # :doc:
  commands = Array(commands)

  dirs_on_path = ENV["PATH"].to_s.split(File::PATH_SEPARATOR)
  unless (ext = RbConfig::CONFIG["EXEEXT"]).empty?
    commands = commands.map { |cmd| "#{cmd}#{ext}" }
  end

  full_path_command = nil
  found = commands.detect do |cmd|
    dirs_on_path.detect do |path|
      full_path_command = File.join(path, cmd)
      begin
        stat = File.stat(full_path_command)
      rescue SystemCallError
      else
        stat.file? && stat.executable?
      end
    end
  end

  if found
    exec full_path_command, *args
  else
    abort("Couldn't find database client: #{commands.join(', ')}. Check your $PATH and try again.")
  end
end

.register_class_with_precision(mapping, key, klass, **kwargs) ⇒ Object

:nodoc:



869
870
871
872
873
874
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 869

def register_class_with_precision(mapping, key, klass, **kwargs) # :nodoc:
  mapping.register_type(key) do |*args|
    precision = extract_precision(args.last)
    klass.new(precision: precision, **kwargs)
  end
end

.type_cast_config_to_boolean(config) ⇒ Object 



65
66
67
68
69
70
71
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 65

def self.type_cast_config_to_boolean(config)
  if config == "false"
    false
  else
    config
  end
end

.type_cast_config_to_integer(config) ⇒ Object 



55
56
57
58
59
60
61
62
63
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 55

def self.type_cast_config_to_integer(config)
  if config.is_a?(Integer)
    config
  elsif SIMPLE_INT.match?(config)
    config.to_i
  else
    config
  end
end

.validate_default_timezone(config) ⇒ Object 



73
74
75
76
77
78
79
80
81
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 73

def self.validate_default_timezone(config)
  case config
  when nil
  when "utc", "local"
    config.to_sym
  else
    raise ArgumentError, "default_timezone must be either 'utc' or 'local'"
  end
end

Instance Method Details

#active? ⇒ Boolean

Checks whether the connection to the database is still active. This includes checking whether the database is actually capable of responding, i.e. whether the connection isn’t stale.

Returns:

  • (Boolean) 


658
659
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 658

def active?
end

#adapter_name ⇒ Object

Returns the human-readable name of the adapter. Use mixed case - one can always use downcase if needed.



355
356
357
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 355

def adapter_name
  self.class::ADAPTER_NAME
end

#add_enum_value ⇒ Object

This is meant to be implemented by the adapters that support custom enum types



590
591
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 590

def add_enum_value(...) # :nodoc:
end

#advisory_locks_enabled? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


605
606
607
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 605

def advisory_locks_enabled? # :nodoc:
  supports_advisory_locks? && @advisory_locks_enabled
end

#async_enabled? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


564
565
566
567
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 564

def async_enabled? # :nodoc:
  supports_concurrent_connections? &&
    !ActiveRecord.async_query_executor.nil? && !pool.async_executor.nil?
end

#build_insert_sql(insert) ⇒ Object

Called by ActiveRecord::InsertAll, Passed an instance of ActiveRecord::InsertAll::Builder, This method implements standard bulk inserts for all databases, but should be overridden by adapters to implement common features with non-standard syntax like handling duplicates or returning values.



842
843
844
845
846
847
848
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 842

def build_insert_sql(insert) # :nodoc:
  if insert.skip_duplicates? || insert.update_duplicates?
    raise NotImplementedError, "#{self.class} should define `build_insert_sql` to implement adapter-specific logic for handling duplicates during INSERT"
  end

  "INSERT #{insert.into} #{insert.values_list}"
end

#case_insensitive_comparison(attribute, value) ⇒ Object

:nodoc:



813
814
815
816
817
818
819
820
821
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 813

def case_insensitive_comparison(attribute, value) # :nodoc:
  column = column_for_attribute(attribute)

  if can_perform_case_insensitive_comparison_for?(column)
    attribute.lower.eq(attribute.relation.lower(value))
  else
    attribute.eq(value)
  end
end

#case_sensitive_comparison(attribute, value) ⇒ Object

:nodoc:



809
810
811
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 809

def case_sensitive_comparison(attribute, value) # :nodoc:
  attribute.eq(value)
end

#check_all_foreign_keys_valid! ⇒ Object

Override to check all foreign key constraints in a database. The adapter should raise a ActiveRecord::StatementInvalid if foreign key constraints are not met.



643
644
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 643

def check_all_foreign_keys_valid!
end

#check_if_write_query(sql) ⇒ Object

:nodoc:



206
207
208
209
210
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 206

def check_if_write_query(sql) # :nodoc:
  if preventing_writes? && write_query?(sql)
    raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
  end
end

#check_version ⇒ Object

:nodoc:



857
858
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 857

def check_version # :nodoc:
end

#clean! ⇒ Object

:nodoc:



782
783
784
785
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 782

def clean! # :nodoc:
  @raw_connection_dirty = false
  @verified = nil
end

#clear_cache!(new_connection: false) ⇒ Object

Clear any caching the database adapter may be doing.



739
740
741
742
743
744
745
746
747
748
749
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 739

def clear_cache!(new_connection: false)
  if @statements
    @lock.synchronize do
      if new_connection
        @statements.reset
      else
        @statements.clear
      end
    end
  end
end

#close ⇒ Object

Check the connection back in to the connection pool



829
830
831
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 829

def close
  pool.checkin self
end

#connect! ⇒ Object 



777
778
779
780
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 777

def connect!
  verify!
  self
end

#connected? ⇒ Boolean

Checks whether the connection to the database was established. This doesn’t include checking whether the database is actually capable of responding, i.e. whether the connection is stale.

Returns:

  • (Boolean) 


651
652
653
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 651

def connected?
  !@raw_connection.nil?
end

#connection_class ⇒ Object

:nodoc:



291
292
293
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 291

def connection_class # :nodoc:
  @pool.connection_class
end

#connection_retries ⇒ Object 



216
217
218
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 216

def connection_retries
  (@config[:connection_retries] || 1).to_i
end

#create_enum ⇒ Object

This is meant to be implemented by the adapters that support custom enum types



578
579
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 578

def create_enum(...) # :nodoc:
end

#create_virtual_table ⇒ Object

This is meant to be implemented by the adapters that support virtual tables



598
599
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 598

def create_virtual_table(*) # :nodoc:
end

#database_exists? ⇒ Boolean

Returns:

  • (Boolean) 


364
365
366
367
368
369
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 364

def database_exists?
  connect!
  true
rescue ActiveRecord::NoDatabaseError
  false
end

#database_version ⇒ Object

:nodoc:



853
854
855
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 853

def database_version # :nodoc:
  pool.server_version(self)
end

#default_index_type?(index) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


833
834
835
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 833

def default_index_type?(index) # :nodoc:
  index.using.nil?
end

#default_timezone ⇒ Object 



228
229
230
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 228

def default_timezone
  @default_timezone || ActiveRecord.default_timezone
end

#default_uniqueness_comparison(attribute, value) ⇒ Object

:nodoc:



805
806
807
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 805

def default_uniqueness_comparison(attribute, value) # :nodoc:
  attribute.eq(value)
end

#disable_extension(name) ⇒ Object

This is meant to be implemented by the adapters that support extensions



570
571
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 570

def disable_extension(name, **)
end

#disable_referential_integrity ⇒ Object

Override to turn off referential integrity while executing &block.



636
637
638
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 636

def disable_referential_integrity
  yield
end

#discard! ⇒ Object

Immediately forget this connection ever existed. Unlike disconnect!, this will not communicate with the server.

After calling this method, the behavior of all other methods becomes undefined. This is called internally just before a forked process gets rid of a connection that belonged to its parent.



714
715
716
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 714

def discard!
  # This should be overridden by concrete adapters.
end

#disconnect! ⇒ Object

Disconnects from the database if already connected. Otherwise, this method does nothing.



700
701
702
703
704
705
706
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 700

def disconnect!
  @lock.synchronize do
    clear_cache!(new_connection: true)
    reset_transaction
    @raw_connection_dirty = false
  end
end

#drop_enum ⇒ Object

This is meant to be implemented by the adapters that support custom enum types



582
583
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 582

def drop_enum(...) # :nodoc:
end

#drop_virtual_table ⇒ Object

This is meant to be implemented by the adapters that support virtual tables



602
603
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 602

def drop_virtual_table(*) # :nodoc:
end

#enable_extension(name) ⇒ Object

This is meant to be implemented by the adapters that support extensions



574
575
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 574

def enable_extension(name, **)
end

#expire ⇒ Object

this method must only be called while holding connection pool’s mutex



312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 312

def expire
  if in_use?
    if @owner != ActiveSupport::IsolatedExecutionState.context
      raise ActiveRecordError, "Cannot expire connection, " \
        "it is owned by a different thread: #{@owner}. " \
        "Current thread: #{ActiveSupport::IsolatedExecutionState.context}."
    end

    @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    @owner = nil
  else
    raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
  end
end

#extensions ⇒ Object

A list of extensions, to be filled in by adapters that support them.



624
625
626
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 624

def extensions
  []
end

#get_advisory_lock(lock_id) ⇒ Object

This is meant to be implemented by the adapters that support advisory locks

Return true if we got the lock, otherwise false



613
614
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 613

def get_advisory_lock(lock_id) # :nodoc:
end

#get_database_version ⇒ Object

:nodoc:



850
851
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 850

def get_database_version # :nodoc:
end

#index_algorithms ⇒ Object

A list of index algorithms, to be filled by adapters that support them.



629
630
631
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 629

def index_algorithms
  {}
end

#inspect ⇒ Object

:nodoc:



174
175
176
177
178
179
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 174

def inspect # :nodoc:
  name_field = " name=#{pool.db_config.name.inspect}" unless pool.db_config.name == "primary"
  shard_field = " shard=#{shard.inspect}" unless shard == :default

  "#<#{self.class.name}:#{'%#016x' % (object_id << 1)} env_name=#{pool.db_config.env_name.inspect}#{name_field} role=#{role.inspect}#{shard_field}>"
end

#lease ⇒ Object

this method must only be called while holding connection pool’s mutex



276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 276

def lease
  if in_use?
    msg = +"Cannot lease connection, "
    if @owner == ActiveSupport::IsolatedExecutionState.context
      msg << "it is already leased by the current thread."
    else
      msg << "it is already in use by a different thread: #{@owner}. " \
             "Current thread: #{ActiveSupport::IsolatedExecutionState.context}."
    end
    raise ActiveRecordError, msg
  end

  @owner = ActiveSupport::IsolatedExecutionState.context
end

#lock_thread=(lock_thread) ⇒ Object

:nodoc:



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 181

def lock_thread=(lock_thread) # :nodoc:
  @lock =
  case lock_thread
  when Thread
    ActiveSupport::Concurrency::ThreadLoadInterlockAwareMonitor.new
  when Fiber
    ActiveSupport::Concurrency::LoadInterlockAwareMonitor.new
  else
    ActiveSupport::Concurrency::NullLock
  end
end

#prefetch_primary_key?(table_name = nil) ⇒ Boolean

Should primary key values be selected from their corresponding sequence before the insert statement? If true, next_sequence_value is called before each insert to set the record’s primary key.

Returns:

  • (Boolean) 


404
405
406
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 404

def prefetch_primary_key?(table_name = nil)
  false
end

#prepared_statements? ⇒ Boolean Also known as: prepared_statements

Returns:

  • (Boolean) 


243
244
245
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 243

def prepared_statements?
  @prepared_statements && !prepared_statements_disabled_cache.include?(object_id)
end

#prepared_statements_disabled_cache ⇒ Object

:nodoc:



248
249
250
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 248

def prepared_statements_disabled_cache # :nodoc:
  ActiveSupport::IsolatedExecutionState[:active_record_prepared_statements_disabled_cache] ||= Set.new
end

#preventing_writes? ⇒ Boolean

Determines whether writes are currently being prevented.

Returns true if the connection is a replica or returns the value of current_preventing_writes.

Returns:

  • (Boolean) 


236
237
238
239
240
241
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 236

def preventing_writes?
  return true if replica?
  return false if connection_class.nil?

  connection_class.current_preventing_writes
end

#raw_connection ⇒ Object

Provides access to the underlying database driver for this adapter. For example, this method returns a Mysql2::Client object in case of Mysql2Adapter, and a PG::Connection object in case of PostgreSQLAdapter.

This is useful for when you need to call a proprietary method such as PostgreSQL’s lo_* methods.

Active Record cannot track if the database is getting modified using this client. If that is the case, generally you’ll want to invalidate the query cache using ActiveRecord::Base.clear_query_cache.



797
798
799
800
801
802
803
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 797

def raw_connection
  with_raw_connection do |conn|
    disable_lazy_transactions!
    @raw_connection_dirty = true
    conn
  end
end

#reconnect!(restore_transactions: false) ⇒ Object

Disconnects from the database if already connected, and establishes a new connection with the database. Implementors should define private #reconnect instead.



664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 664

def reconnect!(restore_transactions: false)
  retries_available = connection_retries
  deadline = retry_deadline && Process.clock_gettime(Process::CLOCK_MONOTONIC) + retry_deadline

  @lock.synchronize do
    reconnect

    enable_lazy_transactions!
    @raw_connection_dirty = false
    @verified = true

    reset_transaction(restore: restore_transactions) do
      clear_cache!(new_connection: true)
      configure_connection
    end
  rescue => original_exception
    translated_exception = translate_exception_class(original_exception, nil, nil)
    retry_deadline_exceeded = deadline && deadline < Process.clock_gettime(Process::CLOCK_MONOTONIC)

    if !retry_deadline_exceeded && retries_available > 0
      retries_available -= 1

      if retryable_connection_error?(translated_exception)
        backoff(connection_retries - retries_available)
        retry
      end
    end

    @verified = false

    raise translated_exception
  end
end

#release_advisory_lock(lock_id) ⇒ Object

This is meant to be implemented by the adapters that support advisory locks.

Return true if we released the lock, otherwise false



620
621
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 620

def release_advisory_lock(lock_id) # :nodoc:
end

#rename_enum ⇒ Object

This is meant to be implemented by the adapters that support custom enum types



586
587
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 586

def rename_enum(...) # :nodoc:
end

#rename_enum_value ⇒ Object

This is meant to be implemented by the adapters that support custom enum types



594
595
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 594

def rename_enum_value(...) # :nodoc:
end

#replica? ⇒ Boolean

Returns:

  • (Boolean) 


212
213
214
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 212

def replica?
  @config[:replica] || false
end

#requires_reloading? ⇒ Boolean

Returns true if its required to reload the connection between requests for development mode.

Returns:

  • (Boolean) 


752
753
754
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 752

def requires_reloading?
  false
end

#reset! ⇒ Object

Reset the state of this connection, directing the DBMS to clear transactions and other connection-related server-side state. Usually a database-dependent operation.

If a database driver or protocol does not support such a feature, implementors may alias this to #reconnect!. Otherwise, implementors should call super immediately after resetting the connection (and while still holding @lock).



726
727
728
729
730
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 726

def reset!
  clear_cache!(new_connection: true)
  reset_transaction
  configure_connection
end

#retry_deadline ⇒ Object 



220
221
222
223
224
225
226
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 220

def retry_deadline
  if @config[:retry_deadline]
    @config[:retry_deadline].to_f
  else
    nil
  end
end

#return_value_after_insert?(column) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


560
561
562
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 560

def return_value_after_insert?(column) # :nodoc:
  column.auto_populated?
end

#role ⇒ Object

The role (e.g. :writing) for the current connection. In a non-multi role application, :writing is returned.



297
298
299
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 297

def role
  @pool.role
end

#savepoint_errors_invalidate_transactions? ⇒ Boolean

Do TransactionRollbackErrors on savepoints affect the parent transaction?

Returns:

  • (Boolean) 


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

def savepoint_errors_invalidate_transactions?
  false
end

#schema_cache ⇒ Object 



307
308
309
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 307

def schema_cache
  @pool.schema_cache || (@schema_cache ||= BoundSchemaReflection.for_lone_connection(@pool.schema_reflection, self))
end

#schema_version ⇒ Object

Returns the version identifier of the schema currently available in the database. This is generally equal to the number of the highest- numbered migration that has been executed, or 0 if no schema information is present / the database is empty.



864
865
866
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 864

def schema_version
  pool.migration_context.current_version
end

#seconds_idle ⇒ Object

Seconds since this connection was returned to the pool



341
342
343
344
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 341

def seconds_idle # :nodoc:
  return 0 if in_use?
  Process.clock_gettime(Process::CLOCK_MONOTONIC) - @idle_since
end

#shard ⇒ Object

The shard (e.g. :default) for the current connection. In a non-sharded application, :default is returned.



303
304
305
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 303

def shard
  @pool.shard
end

#steal! ⇒ Object

this method must only be called while holding connection pool’s mutex (and a desire for segfaults)



328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 328

def steal! # :nodoc:
  if in_use?
    if @owner != ActiveSupport::IsolatedExecutionState.context
      pool.send :remove_connection_from_thread_cache, self, @owner

      @owner = ActiveSupport::IsolatedExecutionState.context
    end
  else
    raise ActiveRecordError, "Cannot steal connection, it is not currently leased."
  end
end

#supports_advisory_locks? ⇒ Boolean

Does this adapter support application-enforced advisory locking?

Returns:

  • (Boolean) 


397
398
399
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 397

def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 377

def supports_bulk_alter?
  false
end

#supports_check_constraints? ⇒ Boolean

Does this adapter support creating check constraints?

Returns:

  • (Boolean) 


469
470
471
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 469

def supports_check_constraints?
  false
end

#supports_comments? ⇒ Boolean

Does this adapter support metadata comments on database objects (tables, columns, indexes)?

Returns:

  • (Boolean) 


504
505
506
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 504

def supports_comments?
  false
end

#supports_comments_in_create? ⇒ Boolean

Can comments for tables, columns, and indexes be specified in create/alter table statements?

Returns:

  • (Boolean) 


509
510
511
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 509

def supports_comments_in_create?
  false
end

#supports_common_table_expressions? ⇒ Boolean

Returns:

  • (Boolean) 


528
529
530
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 528

def supports_common_table_expressions?
  false
end

#supports_concurrent_connections? ⇒ Boolean

Returns:

  • (Boolean) 


552
553
554
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 552

def supports_concurrent_connections?
  true
end

#supports_datetime_with_precision? ⇒ Boolean

Does this adapter support datetime with precision?

Returns:

  • (Boolean) 


494
495
496
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 494

def supports_datetime_with_precision?
  false
end

#supports_ddl_transactions? ⇒ Boolean

Does this adapter support DDL rollbacks in transactions? That is, would CREATE TABLE or ALTER TABLE get rolled back by a transaction?

Returns:

  • (Boolean) 


373
374
375
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 373

def supports_ddl_transactions?
  false
end

#supports_deferrable_constraints? ⇒ Boolean

Does this adapter support creating deferrable constraints?

Returns:

  • (Boolean) 


464
465
466
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 464

def supports_deferrable_constraints?
  false
end

#supports_exclusion_constraints? ⇒ Boolean

Does this adapter support creating exclusion constraints?

Returns:

  • (Boolean) 


474
475
476
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 474

def supports_exclusion_constraints?
  false
end

#supports_explain? ⇒ Boolean

Does this adapter support explain?

Returns:

  • (Boolean) 


433
434
435
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 433

def supports_explain?
  false
end

#supports_expression_index? ⇒ Boolean

Does this adapter support expression indices?

Returns:

  • (Boolean) 


428
429
430
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 428

def supports_expression_index?
  false
end

#supports_extensions? ⇒ Boolean

Does this adapter support database extensions?

Returns:

  • (Boolean) 


443
444
445
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 443

def supports_extensions?
  false
end

#supports_foreign_keys? ⇒ Boolean

Does this adapter support creating foreign key constraints?

Returns:

  • (Boolean) 


454
455
456
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 454

def supports_foreign_keys?
  false
end

#supports_foreign_tables? ⇒ Boolean

Does this adapter support foreign/external tables?

Returns:

  • (Boolean) 


519
520
521
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 519

def supports_foreign_tables?
  false
end

#supports_index_include? ⇒ Boolean

Does this adapter support including non-key columns?

Returns:

  • (Boolean) 


423
424
425
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 423

def supports_index_include?
  false
end

#supports_index_sort_order? ⇒ Boolean

Does this adapter support index sort order?

Returns:

  • (Boolean) 


413
414
415
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 413

def supports_index_sort_order?
  false
end

#supports_indexes_in_create? ⇒ Boolean

Does this adapter support creating indexes in the same statement as creating the table?

Returns:

  • (Boolean) 


449
450
451
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 449

def supports_indexes_in_create?
  false
end

#supports_insert_conflict_target? ⇒ Boolean

Returns:

  • (Boolean) 


548
549
550
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 548

def supports_insert_conflict_target?
  false
end

#supports_insert_on_duplicate_skip? ⇒ Boolean

Returns:

  • (Boolean) 


540
541
542
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 540

def supports_insert_on_duplicate_skip?
  false
end

#supports_insert_on_duplicate_update? ⇒ Boolean

Returns:

  • (Boolean) 


544
545
546
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 544

def supports_insert_on_duplicate_update?
  false
end

#supports_insert_returning? ⇒ Boolean

Returns:

  • (Boolean) 


536
537
538
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 536

def supports_insert_returning?
  false
end

#supports_json? ⇒ Boolean

Does this adapter support JSON data type?

Returns:

  • (Boolean) 


499
500
501
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 499

def supports_json?
  false
end

#supports_lazy_transactions? ⇒ Boolean

Returns:

  • (Boolean) 


532
533
534
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 532

def supports_lazy_transactions?
  false
end

#supports_materialized_views? ⇒ Boolean

Does this adapter support materialized views?

Returns:

  • (Boolean) 


489
490
491
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 489

def supports_materialized_views?
  false
end

#supports_nulls_not_distinct? ⇒ Boolean

Returns:

  • (Boolean) 


556
557
558
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 556

def supports_nulls_not_distinct?
  false
end

#supports_optimizer_hints? ⇒ Boolean

Does this adapter support optimizer hints?

Returns:

  • (Boolean) 


524
525
526
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 524

def supports_optimizer_hints?
  false
end

#supports_partial_index? ⇒ Boolean

Does this adapter support partial indices?

Returns:

  • (Boolean) 


418
419
420
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 418

def supports_partial_index?
  false
end

#supports_partitioned_indexes? ⇒ Boolean

Returns:

  • (Boolean) 


408
409
410
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 408

def supports_partitioned_indexes?
  false
end

#supports_restart_db_transaction? ⇒ Boolean

Returns:

  • (Boolean) 


392
393
394
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 392

def supports_restart_db_transaction?
  false
end

#supports_savepoints? ⇒ Boolean

Does this adapter support savepoints?

Returns:

  • (Boolean) 


382
383
384
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 382

def supports_savepoints?
  false
end

#supports_transaction_isolation? ⇒ Boolean

Does this adapter support setting the isolation level for a transaction?

Returns:

  • (Boolean) 


438
439
440
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 438

def supports_transaction_isolation?
  false
end

#supports_unique_constraints? ⇒ Boolean

Does this adapter support creating unique constraints?

Returns:

  • (Boolean) 


479
480
481
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 479

def supports_unique_constraints?
  false
end

#supports_validate_constraints? ⇒ Boolean

Does this adapter support creating invalid constraints?

Returns:

  • (Boolean) 


459
460
461
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 459

def supports_validate_constraints?
  false
end

#supports_views? ⇒ Boolean

Does this adapter support views?

Returns:

  • (Boolean) 


484
485
486
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 484

def supports_views?
  false
end

#supports_virtual_columns? ⇒ Boolean

Does this adapter support virtual columns?

Returns:

  • (Boolean) 


514
515
516
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 514

def supports_virtual_columns?
  false
end

#throw_away! ⇒ Object

Removes the connection from the pool and disconnect it.



733
734
735
736
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 733

def throw_away!
  pool.remove self
  disconnect!
end

#unprepared_statement ⇒ Object 



346
347
348
349
350
351
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 346

def unprepared_statement
  cache = prepared_statements_disabled_cache.add?(object_id) if @prepared_statements
  yield
ensure
  cache&.delete(object_id)
end

#valid_type?(type) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


271
272
273
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 271

def valid_type?(type) # :nodoc:
  !native_database_types[type].nil?
end

#verify! ⇒ Object

Checks whether the connection to the database is still active (i.e. not stale). This is done under the hood by calling #active?. If the connection is no longer active, then this method will reconnect to the database.



759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 759

def verify!
  unless active?
    @lock.synchronize do
      if @unconfigured_connection
        @raw_connection = @unconfigured_connection
        @unconfigured_connection = nil
        configure_connection
        @verified = true
        return
      end

      reconnect!(restore_transactions: true)
    end
  end

  @verified = true
end

#with_instrumenter(instrumenter, &block) ⇒ Object

:nodoc:



196
197
198
199
200
201
202
203
204
 
# File 'lib/active_record/connection_adapters/abstract_adapter.rb', line 196

def with_instrumenter(instrumenter, &block) # :nodoc:
  Thread.handle_interrupt(EXCEPTION_NEVER) do
    previous_instrumenter = @instrumenter
    @instrumenter = instrumenter
    Thread.handle_interrupt(EXCEPTION_IMMEDIATE, &block)
  ensure
    @instrumenter = previous_instrumenter
  end
end