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 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.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)|/\*(?:[^*]|\*[^/])*\*/}m
TYPE_MAP =
Type::TypeMap.new.tap { |m| initialize_type_map(m) }
EXTENDED_TYPE_MAPS =
Concurrent::Map.new

Constants included from ActiveSupport::Callbacks

ActiveSupport::Callbacks::CALLBACK_FILTER_TYPES

Instance Attribute Summary collapse

Attributes included from QueryCache

#query_cache, #query_cache_enabled

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, #select_all, #uncached

Methods included from DatabaseLimits

#index_name_length, #max_identifier_length, #table_alias_length

Methods included from Quoting

#column_name_matcher, #column_name_with_order_matcher, #lookup_cast_type_from_column, #quote, #quote_bound_value, #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_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, #mark_transaction_written_if_write, #query, #query_value, #query_values, #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, #change_column, #change_column_comment, #change_column_default, #change_column_null, #change_table, #change_table_comment, #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, #native_database_types, #options_include_default?, #primary_key, #quoted_columns_for_index, #remove_check_constraint, #remove_column, #remove_columns, #remove_foreign_key, #remove_index, #remove_reference, #remove_timestamps, #rename_column, #rename_index, #rename_table, #table_alias_for, #table_comment, #table_exists?, #table_options, #tables, #type_to_sql, #update_table_definition, #view_exists?, #views

Methods included from ActiveSupport::Callbacks

#run_callbacks

Methods included from ActiveSupport::Concern

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

Constructor Details

#initialize(connection, logger = nil, config = {}) ⇒ AbstractAdapter

:nodoc:


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
119
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 92

def initialize(connection, logger = nil, config = {}) # :nodoc:
  super()

  @raw_connection      = connection
  @owner               = nil
  @instrumenter        = ActiveSupport::Notifications.instrumenter
  @logger              = logger
  @config              = config
  @pool                = ActiveRecord::ConnectionAdapters::NullPool.new
  @idle_since          = Process.clock_gettime(Process::CLOCK_MONOTONIC)
  @visitor = arel_visitor
  @statements = build_statement_pool
  @lock = ActiveSupport::Concurrency::LoadInterlockAwareMonitor.new

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

  @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

  configure_connection
end

Instance Attribute Details

#lockObject (readonly)

Returns the value of attribute lock.


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

def lock
  @lock
end

#loggerObject (readonly)

Returns the value of attribute logger.


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

def logger
  @logger
end

#ownerObject (readonly) Also known as: in_use?

Returns the value of attribute owner.


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

def owner
  @owner
end

#poolObject

Returns the value of attribute pool.


41
42
43
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 41

def pool
  @pool
end

#visitorObject (readonly)

Returns the value of attribute visitor.


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

def visitor
  @visitor
end

Class Method Details

.build_read_query_regexp(*parts) ⇒ Object

:nodoc:


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

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)

Raises:

  • (NotImplementedError)

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

def self.database_exists?(config)
  raise NotImplementedError
end

.extended_type_map(default_timezone:) ⇒ Object

:nodoc:


721
722
723
724
725
726
727
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 721

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

.quoted_column_namesObject

:nodoc:


84
85
86
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 84

def self.quoted_column_names # :nodoc:
  @quoted_column_names ||= {}
end

.quoted_table_namesObject

:nodoc:


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

def self.quoted_table_names # :nodoc:
  @quoted_table_names ||= {}
end

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

:nodoc:


714
715
716
717
718
719
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 714

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


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

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

.type_cast_config_to_integer(config) ⇒ Object


47
48
49
50
51
52
53
54
55
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 47

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


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

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)

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

def active?
end

#adapter_nameObject

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


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

def adapter_name
  self.class::ADAPTER_NAME
end

#advisory_locks_enabled?Boolean

:nodoc:

Returns:

  • (Boolean)

502
503
504
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 502

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

#all_foreign_keys_valid?Boolean

Override to check all foreign key constraints in a database.

Returns:

  • (Boolean)

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

def all_foreign_keys_valid?
  true
end

#async_enabled?Boolean

:nodoc:

Returns:

  • (Boolean)

485
486
487
488
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 485

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.


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

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:


649
650
651
652
653
654
655
656
657
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 649

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:


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

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

#check_if_write_query(sql) ⇒ Object

:nodoc:


134
135
136
137
138
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 134

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_versionObject

:nodoc:


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

def check_version # :nodoc:
end

#clear_cache!(new_connection: false) ⇒ Object

Clear any caching the database adapter may be doing.


605
606
607
608
609
610
611
612
613
614
615
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 605

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

#closeObject

Check the connection back in to the connection pool


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

def close
  pool.checkin self
end

#connection_classObject

:nodoc:


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

def connection_class # :nodoc:
  @pool.connection_class
end

#create_enumObject

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


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

def create_enum(*) # :nodoc:
end

#database_versionObject

:nodoc:


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

def database_version # :nodoc:
  schema_cache.database_version
end

#default_index_type?(index) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

669
670
671
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 669

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

#default_timezoneObject


148
149
150
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 148

def default_timezone
  @default_timezone || ActiveRecord.default_timezone
end

#default_uniqueness_comparison(attribute, value) ⇒ Object

:nodoc:


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

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


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

def disable_extension(name)
end

#disable_referential_integrityObject

Override to turn off referential integrity while executing &block.


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

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.


574
575
576
577
578
579
580
581
582
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 574

def discard!
  # This should be overridden by concrete adapters.
  #
  # Prevent @raw_connection's finalizer from touching the socket, or
  # otherwise communicating with its server, when it is collected.
  if schema_cache.connection == self
    schema_cache.connection = nil
  end
end

#disconnect!Object

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


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

def disconnect!
  clear_cache!(new_connection: true)
  reset_transaction
end

#enable_extension(name) ⇒ Object

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


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

def enable_extension(name)
end

#expireObject

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


263
264
265
266
267
268
269
270
271
272
273
274
275
276
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 263

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

#extensionsObject

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


521
522
523
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 521

def extensions
  []
end

#field_ordered_value(column, values) ⇒ Object

:nodoc:


704
705
706
707
708
709
710
711
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 704

def field_ordered_value(column, values) # :nodoc:
  node = Arel::Nodes::Case.new(column)
  values.each.with_index(1) do |value, order|
    node.when(value).then(order)
  end

  Arel::Nodes::Ascending.new(node.else(values.length + 1))
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


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

def get_advisory_lock(lock_id) # :nodoc:
end

#get_database_versionObject

:nodoc:


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

def get_database_version # :nodoc:
end

#index_algorithmsObject

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


526
527
528
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 526

def index_algorithms
  {}
end

#leaseObject

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


222
223
224
225
226
227
228
229
230
231
232
233
234
235
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 222

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

#migration_contextObject

:nodoc:


167
168
169
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 167

def migration_context # :nodoc:
  MigrationContext.new(migrations_paths, schema_migration)
end

#migrations_pathsObject

:nodoc:


163
164
165
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 163

def migrations_paths # :nodoc:
  @config[:migrations_paths] || Migrator.migrations_paths
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)

348
349
350
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 348

def prefetch_primary_key?(table_name = nil)
  false
end

#prepared_statements?Boolean Also known as: prepared_statements

Returns:

  • (Boolean)

189
190
191
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 189

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

#prepared_statements_disabled_cacheObject

:nodoc:


194
195
196
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 194

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)

156
157
158
159
160
161
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 156

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

  connection_class.current_preventing_writes
end

#raw_connectionObject

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.


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

def raw_connection
  disable_lazy_transactions!
  @raw_connection_dirty = true
  @raw_connection
end

#reconnect!(restore_transactions: false) ⇒ Object

Disconnects from the database if already connected, and establishes a new connection with the database. Implementors should call super immediately after establishing the new connection (and while still holding @lock).


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

def reconnect!(restore_transactions: false)
  reset_transaction(restore: restore_transactions) do
    clear_cache!(new_connection: true)
    configure_connection
  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


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

def release_advisory_lock(lock_id) # :nodoc:
end

#replica?Boolean

Returns:

  • (Boolean)

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

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)

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

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


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

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

#roleObject

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


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

def role
  @pool.role
end

#savepoint_errors_invalidate_transactions?Boolean

Do TransactionRollbackErrors on savepoints affect the parent transaction?

Returns:

  • (Boolean)

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

def savepoint_errors_invalidate_transactions?
  false
end

#schema_cacheObject


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

def schema_cache
  @pool.get_schema_cache(self)
end

#schema_cache=(cache) ⇒ Object


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

def schema_cache=(cache)
  cache.connection = self
  @pool.set_schema_cache(cache)
end

#schema_migrationObject

:nodoc:


171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 171

def schema_migration # :nodoc:
  @schema_migration ||= begin
                          conn = self
                          spec_name = conn.pool.pool_config.connection_specification_name

                          return ActiveRecord::SchemaMigration if spec_name == "ActiveRecord::Base"

                          schema_migration_name = "#{spec_name}::SchemaMigration"

                          Class.new(ActiveRecord::SchemaMigration) do
                            define_singleton_method(:name) { schema_migration_name }
                            define_singleton_method(:to_s) { schema_migration_name }

                            self.connection_specification_name = spec_name
                          end
                        end
end

#schema_versionObject

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.


700
701
702
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 700

def schema_version
  migration_context.current_version
end

#seconds_idleObject

Seconds since this connection was returned to the pool


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

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

#shardObject

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


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

def shard
  @pool.shard
end

#steal!Object

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


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

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)

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

def supports_advisory_locks?
  false
end

#supports_bulk_alter?Boolean

Returns:

  • (Boolean)

321
322
323
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 321

def supports_bulk_alter?
  false
end

#supports_check_constraints?Boolean

Does this adapter support creating check constraints?

Returns:

  • (Boolean)

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

def supports_check_constraints?
  false
end

#supports_comments?Boolean

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

Returns:

  • (Boolean)

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

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)

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

def supports_comments_in_create?
  false
end

#supports_common_table_expressions?Boolean

Returns:

  • (Boolean)

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

def supports_common_table_expressions?
  false
end

#supports_concurrent_connections?Boolean

Returns:

  • (Boolean)

481
482
483
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 481

def supports_concurrent_connections?
  true
end

#supports_datetime_with_precision?Boolean

Does this adapter support datetime with precision?

Returns:

  • (Boolean)

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

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)

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

def supports_ddl_transactions?
  false
end

#supports_deferrable_constraints?Boolean

Does this adapter support creating deferrable constraints?

Returns:

  • (Boolean)

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

def supports_deferrable_constraints?
  false
end

#supports_explain?Boolean

Does this adapter support explain?

Returns:

  • (Boolean)

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

def supports_explain?
  false
end

#supports_expression_index?Boolean

Does this adapter support expression indices?

Returns:

  • (Boolean)

367
368
369
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 367

def supports_expression_index?
  false
end

#supports_extensions?Boolean

Does this adapter support database extensions?

Returns:

  • (Boolean)

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

def supports_extensions?
  false
end

#supports_foreign_keys?Boolean

Does this adapter support creating foreign key constraints?

Returns:

  • (Boolean)

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

def supports_foreign_keys?
  false
end

#supports_foreign_tables?Boolean

Does this adapter support foreign/external tables?

Returns:

  • (Boolean)

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

def supports_foreign_tables?
  false
end

#supports_index_sort_order?Boolean

Does this adapter support index sort order?

Returns:

  • (Boolean)

357
358
359
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 357

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)

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

def supports_indexes_in_create?
  false
end

#supports_insert_conflict_target?Boolean

Returns:

  • (Boolean)

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

def supports_insert_conflict_target?
  false
end

#supports_insert_on_duplicate_skip?Boolean

Returns:

  • (Boolean)

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

def supports_insert_on_duplicate_skip?
  false
end

#supports_insert_on_duplicate_update?Boolean

Returns:

  • (Boolean)

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

def supports_insert_on_duplicate_update?
  false
end

#supports_insert_returning?Boolean

Returns:

  • (Boolean)

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

def supports_insert_returning?
  false
end

#supports_json?Boolean

Does this adapter support json data type?

Returns:

  • (Boolean)

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

def supports_json?
  false
end

#supports_lazy_transactions?Boolean

Returns:

  • (Boolean)

461
462
463
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 461

def supports_lazy_transactions?
  false
end

#supports_materialized_views?Boolean

Does this adapter support materialized views?

Returns:

  • (Boolean)

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

def supports_materialized_views?
  false
end

#supports_optimizer_hints?Boolean

Does this adapter support optimizer hints?

Returns:

  • (Boolean)

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

def supports_optimizer_hints?
  false
end

#supports_partial_index?Boolean

Does this adapter support partial indices?

Returns:

  • (Boolean)

362
363
364
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 362

def supports_partial_index?
  false
end

#supports_partitioned_indexes?Boolean

Returns:

  • (Boolean)

352
353
354
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 352

def supports_partitioned_indexes?
  false
end

#supports_restart_db_transaction?Boolean

Returns:

  • (Boolean)

336
337
338
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 336

def supports_restart_db_transaction?
  false
end

#supports_savepoints?Boolean

Does this adapter support savepoints?

Returns:

  • (Boolean)

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

def supports_savepoints?
  false
end

#supports_transaction_isolation?Boolean

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

Returns:

  • (Boolean)

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

def supports_transaction_isolation?
  false
end

#supports_validate_constraints?Boolean

Does this adapter support creating invalid constraints?

Returns:

  • (Boolean)

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

def supports_validate_constraints?
  false
end

#supports_views?Boolean

Does this adapter support views?

Returns:

  • (Boolean)

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

def supports_views?
  false
end

#supports_virtual_columns?Boolean

Does this adapter support virtual columns?

Returns:

  • (Boolean)

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

def supports_virtual_columns?
  false
end

#throw_away!Object

Removes the connection from the pool and disconnect it.


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

def throw_away!
  pool.remove self
  disconnect!
end

#unprepared_statementObject


297
298
299
300
301
302
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 297

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

#use_metadata_table?Boolean

Returns:

  • (Boolean)

144
145
146
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 144

def 
  @config.fetch(:use_metadata_table, true)
end

#valid_type?(type) ⇒ Boolean

:nodoc:

Returns:

  • (Boolean)

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

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.


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

def verify!
  reconnect! unless active?
end

#with_instrumenter(instrumenter, &block) ⇒ Object

:nodoc:


124
125
126
127
128
129
130
131
132
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 124

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