Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

Inherits:
Object
  • Object
show all
Includes:
DatabaseLimits, DatabaseStatements, QueryCache, Quoting, Savepoints, SchemaStatements, ActiveSupport::Callbacks
Defined in:
activerecord/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)|/\*(?:[^*]|\*[^/])*\*/}
MAX_JITTER =

:nodoc:

0.0..1.0
TYPE_MAP = 
Type::TypeMap.new.tap { |m| initialize_type_map(m) }
EXTENDED_TYPE_MAPS = 
Concurrent::Map.new

Constants included from QueryCache

QueryCache::DEFAULT_SIZE

Constants included from ActiveSupport::Callbacks

ActiveSupport::Callbacks::CALLBACK_FILTER_TYPES

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, #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, #type_casted_binds, #unquoted_false, #unquoted_true

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Methods included from DatabaseStatements

#_exec_insert, #add_transaction_record, #begin_db_transaction, #begin_deferred_transaction, #begin_isolated_db_transaction, #cacheable_query, #commit_db_transaction, #default_insert_value, #default_sequence_name, #delete, #empty_all_tables, #empty_insert_statement_value, #exec_delete, #exec_insert, #exec_insert_all, #exec_query, #exec_restart_db_transaction, #exec_rollback_db_transaction, #exec_update, #execute, #execute_batch, #execute_intent, #explain, #high_precision_current_timestamp, #insert, #insert_fixture, #insert_fixtures_set, #query_all, #query_command, #query_one, #query_rows, #query_value, #query_values, #reset_isolation_level, #reset_sequence!, #reset_transaction, #restart_db_transaction, #rollback_db_transaction, #rollback_to_savepoint, #select_all, #select_one, #select_rows, #select_value, #select_values, #to_sql, #to_sql_and_binds, #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, #disable_index, #distinct_relation_for_primary_key, #drop_join_table, #drop_table, #dump_schema_versions, #enable_index, #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, #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

Methods included from ActiveSupport::Callbacks

#run_callbacks

Constructor Details

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

:nodoc:



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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 145

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

  @raw_connection = nil
  @unconfigured_connection = nil
  @connected_since = 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
    @connected_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
    @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
  @pinned = false
  @pool = ActiveRecord::ConnectionAdapters::NullPool.new
  @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  @allow_preconnect = false
  @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
  @last_activity = nil
  @verified = false

  @pool_jitter = rand * max_jitter
end

Instance Attribute Details

#allow_preconnect ⇒ Object

:nodoc:



59
60
61
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 59

def allow_preconnect
  @allow_preconnect
end

#lock ⇒ Object (readonly)

Returns the value of attribute lock.



58
59
60
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 58

def lock
  @lock
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



58
59
60
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 58

def logger
  @logger
end

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

Returns the value of attribute owner.



58
59
60
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 58

def owner
  @owner
end

#pinned ⇒ Object

:nodoc:



60
61
62
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 60

def pinned
  @pinned
end

#pool ⇒ Object

Returns the value of attribute pool.



57
58
59
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 57

def pool
  @pool
end

#visitor ⇒ Object (readonly)

Returns the value of attribute visitor.



58
59
60
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 58

def visitor
  @visitor
end

Class Method Details

.build_read_query_regexp(*parts) ⇒ Object

:nodoc:



106
107
108
109
110
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 106

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?



410
411
412
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 410

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

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

Opens a database console session.

Raises:

  • (NotImplementedError) 


141
142
143
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 141

def self.dbconsole(config, options = {})
  raise NotImplementedError.new("#{self.class} should define `dbconsole` that accepts a db config and options to implement connecting to the db console")
end

.extended_type_map(default_timezone:) ⇒ Object

:nodoc:



947
948
949
950
951
952
953
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 947

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:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 112

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:



940
941
942
943
944
945
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 940

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).freeze
  end
end

.type_cast_config_to_boolean(config) ⇒ Object 



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

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

.type_cast_config_to_integer(config) ⇒ Object 



75
76
77
78
79
80
81
82
83
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 75

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

.valid_type?(type) ⇒ Boolean

:nodoc:



955
956
957
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 955

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

.validate_default_timezone(config) ⇒ Object 



93
94
95
96
97
98
99
100
101
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 93

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.



712
713
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 712

def active?
end

#adapter_name ⇒ Object

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



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

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



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

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

#advisory_locks_enabled? ⇒ Boolean

:nodoc:



659
660
661
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 659

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

#async_enabled? ⇒ Boolean

:nodoc:



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

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.



913
914
915
916
917
918
919
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 913

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:



884
885
886
887
888
889
890
891
892
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 884

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:



880
881
882
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 880

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.



697
698
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 697

def check_all_foreign_keys_valid!
end

#check_version ⇒ Object

:nodoc:



928
929
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 928

def check_version # :nodoc:
end

#clean! ⇒ Object

:nodoc:



850
851
852
853
854
855
856
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 850

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

#clear_cache!(new_connection: false) ⇒ Object

Clear any caching the database adapter may be doing.



802
803
804
805
806
807
808
809
810
811
812
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 802

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



900
901
902
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 900

def close
  pool.checkin self
end

#connect! ⇒ Object 



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

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.



705
706
707
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 705

def connected?
  !@raw_connection.nil?
end

#connection_age ⇒ Object

Seconds since this connection was established. nil if not connected; infinity if the connection has been explicitly retired.



384
385
386
387
388
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 384

def connection_age # :nodoc:
  if @raw_connection && @connected_since
    Process.clock_gettime(Process::CLOCK_MONOTONIC) - @connected_since
  end
end

#connection_descriptor ⇒ Object

:nodoc:



311
312
313
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 311

def connection_descriptor # :nodoc:
  @pool.connection_descriptor
end

#connection_retries ⇒ Object 



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

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



632
633
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 632

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

#create_virtual_table ⇒ Object

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



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

def create_virtual_table(*) # :nodoc:
end

#database_exists? ⇒ Boolean 



414
415
416
417
418
419
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 414

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

#database_version ⇒ Object

:nodoc:



924
925
926
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 924

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

#default_index_type?(index) ⇒ Boolean

:nodoc:



904
905
906
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 904

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

#default_timezone ⇒ Object 



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

def default_timezone
  @default_timezone || ActiveRecord.default_timezone
end

#disable_extension(name) ⇒ Object

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



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

def disable_extension(name, **)
end

#disable_referential_integrity ⇒ Object

Override to turn off referential integrity while executing &block.



690
691
692
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 690

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.



775
776
777
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 775

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

#disconnect! ⇒ Object

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



758
759
760
761
762
763
764
765
766
767
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 758

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

#drop_enum ⇒ Object

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



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

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

#drop_virtual_table ⇒ Object

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



656
657
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 656

def drop_virtual_table(*) # :nodoc:
end

#enable_extension(name) ⇒ Object

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



628
629
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 628

def enable_extension(name, **)
end

#expire(update_idle = true) ⇒ Object

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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 336

def expire(update_idle = true) # :nodoc:
  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

    _run_checkin_callbacks do
      @idle_since = Process.clock_gettime(Process::CLOCK_MONOTONIC) if update_idle
      @owner = nil
      enable_lazy_transactions!
      unset_query_cache!
    end
  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.



678
679
680
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 678

def extensions
  []
end

#force_retirement ⇒ Object

Mark the connection as needing to be retired, as if the age has exceeded the maximum allowed.



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

def force_retirement # :nodoc:
  @connected_since &&= -Float::INFINITY
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



667
668
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 667

def get_advisory_lock(lock_id) # :nodoc:
end

#get_database_version ⇒ Object

:nodoc:



921
922
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 921

def get_database_version # :nodoc:
end

#index_algorithms ⇒ Object

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



683
684
685
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 683

def index_algorithms
  {}
end

#inspect ⇒ Object

:nodoc:



200
201
202
203
204
205
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 200

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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 296

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:



207
208
209
210
211
212
213
214
215
216
217
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 207

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

#max_jitter ⇒ Object 



220
221
222
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 220

def max_jitter
  (@config[:pool_jitter] || 0.2).to_f.clamp(MAX_JITTER)
end

#migration_strategy ⇒ Object

:singleton-method: migration_strategy

Allows configuration of migration strategy per adapter type. When set on a specific adapter class (e.g., PostgreSQLAdapter), all migrations using that adapter will use the specified strategy instead of the global ActiveRecord.migration_strategy.

ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.migration_strategy = CustomPostgresStrategy
ActiveRecord::ConnectionAdapters::Mysql2Adapter.migration_strategy = CustomMySQLStrategy



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

class_attribute :migration_strategy, instance_writer: false

#native_database_types ⇒ Object

:nodoc:



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

def native_database_types # :nodoc:
  self.class.native_database_types
end

#pool_jitter(duration) ⇒ Object 



331
332
333
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 331

def pool_jitter(duration)
  duration * (1.0 - @pool_jitter)
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.



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

def prefetch_primary_key?(table_name = nil)
  false
end

#prepared_statements? ⇒ Boolean Also known as: prepared_statements 



259
260
261
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 259

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

#prepared_statements_disabled_cache ⇒ Object

:nodoc:



264
265
266
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 264

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.



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

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

  connection_descriptor.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.



872
873
874
875
876
877
878
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 872

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.



718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 718

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

  @lock.synchronize do
    attempt_configure_connection do
      @allow_preconnect = false

      reconnect

      enable_lazy_transactions!
      @raw_connection_dirty = false
      @last_activity = @connected_since = Process.clock_gettime(Process::CLOCK_MONOTONIC)
      @verified = true
      @allow_preconnect = 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

      raise translated_exception
    end
  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



674
675
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 674

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



640
641
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 640

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

#rename_enum_value ⇒ Object

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



648
649
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 648

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

#replica? ⇒ Boolean 



224
225
226
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 224

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

#requires_reloading? ⇒ Boolean

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



815
816
817
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 815

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).



787
788
789
790
791
792
793
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 787

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

#retry_deadline ⇒ Object 



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

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

#return_value_after_insert?(column) ⇒ Boolean

:nodoc:



614
615
616
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 614

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.



317
318
319
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 317

def role
  @pool.role
end

#savepoint_errors_invalidate_transactions? ⇒ Boolean

Do TransactionRollbackErrors on savepoints affect the parent transaction?



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

def savepoint_errors_invalidate_transactions?
  false
end

#schema_cache ⇒ Object 



327
328
329
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 327

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.



935
936
937
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 935

def schema_version
  pool.migration_context.current_version
end

#seconds_idle ⇒ Object

Seconds since this connection was returned to the pool



369
370
371
372
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 369

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

#seconds_since_last_activity ⇒ Object

Seconds since this connection last communicated with the server



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

def seconds_since_last_activity # :nodoc:
  if @raw_connection && @last_activity
    Process.clock_gettime(Process::CLOCK_MONOTONIC) - @last_activity
  end
end

#shard ⇒ Object

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



323
324
325
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 323

def shard
  @pool.shard
end

#steal! ⇒ Object

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



356
357
358
359
360
361
362
363
364
365
366
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 356

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?



447
448
449
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 447

def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ Boolean 



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

def supports_bulk_alter?
  false
end

#supports_check_constraints? ⇒ Boolean

Does this adapter support creating check constraints?



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

def supports_check_constraints?
  false
end

#supports_comments? ⇒ Boolean

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



554
555
556
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 554

def supports_comments?
  false
end

#supports_comments_in_create? ⇒ Boolean

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



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

def supports_comments_in_create?
  false
end

#supports_common_table_expressions? ⇒ Boolean 



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

def supports_common_table_expressions?
  false
end

#supports_concurrent_connections? ⇒ Boolean 



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

def supports_concurrent_connections?
  true
end

#supports_datetime_with_precision? ⇒ Boolean

Does this adapter support datetime with precision?



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

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?



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

def supports_ddl_transactions?
  false
end

#supports_deferrable_constraints? ⇒ Boolean

Does this adapter support creating deferrable constraints?



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

def supports_deferrable_constraints?
  false
end

#supports_disabling_indexes? ⇒ Boolean 



610
611
612
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 610

def supports_disabling_indexes?
  false
end

#supports_exclusion_constraints? ⇒ Boolean

Does this adapter support creating exclusion constraints?



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

def supports_exclusion_constraints?
  false
end

#supports_explain? ⇒ Boolean

Does this adapter support explain?



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

def supports_explain?
  false
end

#supports_expression_index? ⇒ Boolean

Does this adapter support expression indices?



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

def supports_expression_index?
  false
end

#supports_extensions? ⇒ Boolean

Does this adapter support database extensions?



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

def supports_extensions?
  false
end

#supports_foreign_keys? ⇒ Boolean

Does this adapter support creating foreign key constraints?



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

def supports_foreign_keys?
  false
end

#supports_foreign_tables? ⇒ Boolean

Does this adapter support foreign/external tables?



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

def supports_foreign_tables?
  false
end

#supports_index_include? ⇒ Boolean

Does this adapter support including non-key columns?



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

def supports_index_include?
  false
end

#supports_index_sort_order? ⇒ Boolean

Does this adapter support index sort order?



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

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?



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

def supports_indexes_in_create?
  false
end

#supports_insert_conflict_target? ⇒ Boolean 



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

def supports_insert_conflict_target?
  false
end

#supports_insert_on_duplicate_skip? ⇒ Boolean 



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

def supports_insert_on_duplicate_skip?
  false
end

#supports_insert_on_duplicate_update? ⇒ Boolean 



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

def supports_insert_on_duplicate_update?
  false
end

#supports_insert_returning? ⇒ Boolean 



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

def supports_insert_returning?
  false
end

#supports_json? ⇒ Boolean

Does this adapter support JSON data type?



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

def supports_json?
  false
end

#supports_lazy_transactions? ⇒ Boolean 



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

def supports_lazy_transactions?
  false
end

#supports_materialized_views? ⇒ Boolean

Does this adapter support materialized views?



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

def supports_materialized_views?
  false
end

#supports_nulls_not_distinct? ⇒ Boolean 



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

def supports_nulls_not_distinct?
  false
end

#supports_optimizer_hints? ⇒ Boolean

Does this adapter support optimizer hints?



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

def supports_optimizer_hints?
  false
end

#supports_partial_index? ⇒ Boolean

Does this adapter support partial indices?



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

def supports_partial_index?
  false
end

#supports_partitioned_indexes? ⇒ Boolean 



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

def supports_partitioned_indexes?
  false
end

#supports_restart_db_transaction? ⇒ Boolean 



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

def supports_restart_db_transaction?
  false
end

#supports_savepoints? ⇒ Boolean

Does this adapter support savepoints?



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

def supports_savepoints?
  false
end

#supports_transaction_isolation? ⇒ Boolean

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



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

def supports_transaction_isolation?
  false
end

#supports_unique_constraints? ⇒ Boolean

Does this adapter support creating unique constraints?



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

def supports_unique_constraints?
  false
end

#supports_validate_constraints? ⇒ Boolean

Does this adapter support creating invalid constraints?



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

def supports_validate_constraints?
  false
end

#supports_views? ⇒ Boolean

Does this adapter support views?



534
535
536
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 534

def supports_views?
  false
end

#supports_virtual_columns? ⇒ Boolean

Does this adapter support virtual columns?



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

def supports_virtual_columns?
  false
end

#throw_away! ⇒ Object

Removes the connection from the pool and disconnect it.



796
797
798
799
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 796

def throw_away!
  pool.remove self
  disconnect!
end

#unprepared_statement ⇒ Object 



396
397
398
399
400
401
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 396

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:



287
288
289
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 287

def valid_type?(type) # :nodoc:
  self.class.valid_type?(type)
end

#verified? ⇒ Boolean

:nodoc:



858
859
860
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 858

def verified? # :nodoc:
  @verified
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.



822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 822

def verify!
  unless active?
    @lock.synchronize do
      if @unconfigured_connection
        attempt_configure_connection do
          @raw_connection = @unconfigured_connection
          @unconfigured_connection = nil
          configure_connection
          @last_activity = Process.clock_gettime(Process::CLOCK_MONOTONIC)
          @verified = true
          @allow_preconnect = true
        end
        return
      end

      reconnect!(restore_transactions: true)
    end
  end

  @last_activity = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  @verified = true
end

#verify_timeout ⇒ Object 



232
233
234
 
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 232

def verify_timeout
  (@config[:verify_timeout] || 2).to_i
end