Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

Relationships & Source Files
Namespace Children
Classes: `Version`
Extension / Inclusion / Inheritance Descendants
Subclasses: AbstractMysqlAdapter, Mysql2Adapter, PostgreSQLAdapter, SQLite3Adapter
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `::ActiveSupport::DescendantsTracker`
Instance Chain: self, `Savepoints`, `::ActiveRecord::QueryCache`, `DatabaseLimits`, `Quoting`, `DatabaseStatements`, `SchemaStatements`, `::ActiveSupport::Callbacks`
Inherits:	Object
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.

Constant Summary

ADAPTER_NAME =
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 29
```
"Abstract"
```
COMMENT_REGEX =
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 39
```
%r{(?:\-\-.*\n)*|/\*(?:[^\*]|\*[^/])*\*/}m
```
SIMPLE_INT =
# File 'activerecord/lib/active_record/connection_adapters/abstract_adapter.rb', line 38
```
/\A\d+\z/
```

`::ActiveSupport::Callbacks` - Included

CALLBACK_FILTER_TYPES

`DatabaseStatements` - Included

DEFAULT_INSERT_VALUE

`Quoting` - Included

COLUMN_NAME, COLUMN_NAME_WITH_ORDER

`::ActiveSupport::Callbacks` - Attributes & Methods

.__callbacks rw
#__callbacks readonly
.__callbacks? ⇒ Boolean rw
#__callbacks? ⇒ Boolean readonly

Class Method Summary

.database_exists?(config) ⇒ Boolean

Does the database for this adapter exist?
.type_cast_config_to_boolean(config)
.type_cast_config_to_integer(config)

`::ActiveSupport::DescendantsTracker` - self

clear, descendants, direct_descendants,
store_inherited	This is the only method that is not thread safe, but is only ever called during the eager loading phase.
subclasses	Alias for ActiveSupport::DescendantsTracker.direct_descendants.

Instance Attribute Summary

#active? ⇒ Boolean readonly

Checks whether the connection to the database is still active.
#in_use? readonly

Alias for #owner.
#lock readonly
#logger readonly
#owner (also: #in_use?) readonly
#pool rw
#prepared_statements readonly

Alias for #prepared_statements?.
#preventing_writes? ⇒ Boolean readonly

Determines whether writes are currently being prevented.
#replica? ⇒ Boolean readonly
#requires_reloading? ⇒ Boolean readonly

Returns true if its required to reload the connection between requests for development mode.
#schema_cache rw
#schema_cache=(cache) rw
#supports_advisory_locks? ⇒ Boolean readonly

Does this adapter support application-enforced advisory locking?
#supports_bulk_alter? ⇒ Boolean readonly
#supports_check_constraints? ⇒ Boolean readonly

Does this adapter support creating check constraints?
#supports_comments? ⇒ Boolean readonly

Does this adapter support metadata comments on database objects (tables, columns, indexes)?
#supports_comments_in_create? ⇒ Boolean readonly

Can comments for tables, columns, and indexes be specified in create/alter table statements?
#supports_common_table_expressions? ⇒ Boolean readonly
#supports_datetime_with_precision? ⇒ Boolean readonly

Does this adapter support datetime with precision?
#supports_ddl_transactions? ⇒ Boolean readonly

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

Does this adapter support explain?
#supports_expression_index? ⇒ Boolean readonly

Does this adapter support expression indices?
#supports_extensions? ⇒ Boolean readonly

Does this adapter support database extensions?
#supports_foreign_keys? ⇒ Boolean readonly

Does this adapter support creating foreign key constraints?
#supports_foreign_tables? ⇒ Boolean readonly

Does this adapter support foreign/external tables?
#supports_index_sort_order? ⇒ Boolean readonly

Does this adapter support index sort order?
#supports_indexes_in_create? ⇒ Boolean readonly

Does this adapter support creating indexes in the same statement as creating the table?
#supports_insert_conflict_target? ⇒ Boolean readonly
#supports_insert_on_duplicate_skip? ⇒ Boolean readonly
#supports_insert_on_duplicate_update? ⇒ Boolean readonly
#supports_insert_returning? ⇒ Boolean readonly
#supports_json? ⇒ Boolean readonly

Does this adapter support json data type?
#supports_lazy_transactions? ⇒ Boolean readonly
#supports_materialized_views? ⇒ Boolean readonly

Does this adapter support materialized views?
#supports_optimizer_hints? ⇒ Boolean readonly

Does this adapter support optimizer hints?
#supports_partial_index? ⇒ Boolean readonly

Does this adapter support partial indices?
#supports_partitioned_indexes? ⇒ Boolean readonly
#supports_savepoints? ⇒ Boolean readonly

Does this adapter support savepoints?
#supports_transaction_isolation? ⇒ Boolean readonly

Does this adapter support setting the isolation level for a transaction?
#supports_validate_constraints? ⇒ Boolean readonly

Does this adapter support creating invalid constraints?
#supports_views? ⇒ Boolean readonly

Does this adapter support views?
#supports_virtual_columns? ⇒ Boolean readonly

Does this adapter support virtual columns?
#use_metadata_table? ⇒ Boolean readonly
#visitor readonly

`DatabaseStatements` - Included

#begin_transaction, #commit_transaction, #current_transaction, #materialize_transactions, #open_transactions, #rollback_transaction, #transaction_open?, #within_new_transaction

Instance Method Summary

#adapter_name

Returns the human-readable name of the adapter.
#clear_cache!

Clear any caching the database adapter may be doing.
#close

Check the connection back in to the connection pool.
#disable_extension(name)

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

Override to turn off referential integrity while executing &block.
#discard!

Immediately forget this connection ever existed.
#disconnect!

Disconnects from the database if already connected.
#enable_extension(name)

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

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

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

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

this method must only be called while holding connection pool’s mutex.
#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.
#prepared_statements? ⇒ Boolean (also: #prepared_statements) readonly
#raw_connection

Provides access to the underlying database driver for this adapter.
#reconnect!

Disconnects from the database if already connected, and establishes a new connection with the database.
#reset!

Reset the state of this connection, directing the DBMS to clear transactions and other connection-related server-side state.
#throw_away!

Removes the connection from the pool and disconnect it.
#unprepared_statement
#verify!

Checks whether the connection to the database is still active (i.e. not stale).
#log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) private

`Savepoints` - Included

#create_savepoint, #current_savepoint_name, #exec_rollback_to_savepoint, #release_savepoint

`DatabaseLimits` - Included

#allowed_index_name_length	Returns the maximum allowed length for an index name.
#in_clause_length	Returns the maximum number of elements in an IN (x,y,z) clause.
#index_name_length	Returns the maximum length of an index name.
#table_alias_length	Returns the maximum length of a table alias.

`Quoting` - Included

#quote	Quotes the column value to help prevent SQL injection attacks.
#quote_column_name	Quotes the column name.
#quote_string	Quotes a string, escaping any ‘ (single quote) and \ (backslash) characters.
#quote_table_name	Quotes the table name.
#quote_table_name_for_assignment	Override to return the quoted table name for assignment.
#quoted_date	Quote date/time values for use in SQL input.
#quoted_false, #quoted_true,
#type_cast	Cast a `value` to a type that the database understands.
#unquoted_false, #unquoted_true

`DatabaseStatements` - Included

#add_transaction_record	Register a record with the current transaction so that its after_commit and after_rollback callbacks can be called.
#begin_db_transaction	Begins the transaction (and turns off auto-committing).
#begin_isolated_db_transaction	Begins the transaction with the isolation level set.
#commit_db_transaction	Commits the transaction (and turns on auto-committing).
#create	Alias for DatabaseStatements#insert.
#default_sequence_name,
#delete	Executes the delete statement and returns the number of rows affected.
#disable_lazy_transactions!, #empty_insert_statement_value, #enable_lazy_transactions!,
#exec_delete	Executes delete `sql` statement in the context of this connection using `binds` as the bind substitutes.
#exec_insert	Executes insert `sql` statement in the context of this connection using `binds` as the bind substitutes.
#exec_query	Executes `sql` statement in the context of this connection using `binds` as the bind substitutes.
#exec_update	Executes update `sql` statement in the context of this connection using `binds` as the bind substitutes.
#execute	Executes the SQL statement in the context of this connection and returns the raw result from the connection adapter.
#initialize,
#insert	Executes an INSERT query and returns the new record’s ID.
#insert_fixture	Inserts the given fixture into the table.
#insert_fixtures_set,
#reset_sequence!	Set the sequence to the max value of the table’s column.
#rollback_db_transaction	Rolls back the transaction (and turns on auto-committing).
#rollback_to_savepoint,
#sanitize_limit	Sanitizes the given LIMIT parameter in order to prevent SQL injection.
#select_all	Returns an `::ActiveRecord::Result` instance.
#select_one	Returns a record hash with the column names as keys and column values as values.
#select_rows	Returns an array of arrays containing the field values.
#select_value	Returns a single value from a record.
#select_values	Returns an array of the values of the first column in a select:
#to_sql	Converts an arel AST to SQL.
#transaction	Runs the given block in a database transaction, and returns the result of the block.
#transaction_isolation_levels,
#truncate	Executes the truncate statement.
#update	Executes the update statement and returns the number of rows affected.
#write_query?	Determines whether the SQL statement is a write query.

`SchemaStatements` - Included

#add_belongs_to	Alias for SchemaStatements#add_reference.
#add_check_constraint	Adds a new check constraint to the table.
#add_column	Add a new `type` column named `column_name` to `table_name`.
#add_foreign_key	Adds a new foreign key.
#add_index	Adds a new index to the table.
#add_reference	Adds a reference.
#add_timestamps	Adds timestamps (`created_at` and `updated_at`) columns to `table_name`.
#assume_migrated_upto_version,
#change_column	Changes the column’s definition according to the new options.
#change_column_comment	Changes the comment for a column or removes it if `nil`.
#change_column_default	Sets a new default value for a column:
#change_column_null	Sets or removes a `NOT NULL` constraint on a column.
#change_table	A block for changing columns in `table`.
#change_table_comment	Changes the comment for a table or removes it if `nil`.
#check_constraints	Returns an array of check constraints for the given table.
#column_exists?	Checks to see if a column exists in a given table.
#columns	Returns an array of `Column` objects for the table specified by `table_name`.
#create_join_table	Creates a new join table with the name created using the lexical order of the first two arguments.
#create_table	Creates a new table with the name `table_name`.
#data_source_exists?	Checks to see if the data source `name` exists on the database.
#data_sources	Returns the relation names useable to back Active Record models.
#drop_join_table	Drops the join table specified by the given arguments.
#drop_table	Drops a table from the database.
#foreign_key_exists?	Checks to see if a foreign key exists on a table for a given foreign key definition.
#foreign_keys	Returns an array of foreign keys for the given table.
#index_exists?	Checks to see if an index exists on a table for a given index definition.
#index_name_exists?	Verifies the existence of an index with a given name.
#indexes	Returns an array of indexes for the given table.
#native_database_types	Returns a hash of mappings from the abstract data types to the native database types.
#options_include_default?,
#primary_key	Returns just a table’s primary key.
#remove_belongs_to	Alias for SchemaStatements#remove_reference.
#remove_check_constraint	Removes the given check constraint from the table.
#remove_column	Removes the column from the table definition.
#remove_columns	Removes the given columns from the table definition.
#remove_foreign_key	Removes the given foreign key from the table.
#remove_index	Removes the given index from the table.
#remove_reference	Removes the reference(s).
#remove_timestamps	Removes the timestamp columns (`created_at` and `updated_at`) from the table definition.
#rename_column	Renames a column.
#rename_index	Renames an index.
#rename_table	Renames a table.
#table_alias_for	Truncates a table alias according to the limits of the current adapter.
#table_comment	Returns the table comment that’s stored in database metadata.
#table_exists?	Checks to see if the table `table_name` exists on the database.
#table_options,
#tables	Returns an array of table names defined in the database.
#view_exists?	Checks to see if the view `view_name` exists on the database.
#views	Returns an array of view names defined in the database.

`::ActiveSupport::Callbacks` - Included

#run_callbacks

Runs the callbacks for the given event.

Class Attribute Details

.__callbacks (rw)

[ GitHub ]

# File 'activesupport/lib/active_support/callbacks.rb', line 67


class_attribute :__callbacks, instance_writer: false, default: {}

.__callbacks? ⇒ `Boolean` (rw)

[ GitHub ]

# File 'activesupport/lib/active_support/callbacks.rb', line 67


class_attribute :__callbacks, instance_writer: false, default: {}

Class Method Details

.database_exists?(config) ⇒ `Boolean`

Does the database for this adapter exist?

Raises:

(NotImplementedError)

[ GitHub ]

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


def self.database_exists?(config)
  raise NotImplementedError
end

.type_cast_config_to_boolean(config)

[ GitHub ]

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

[ GitHub ]

# 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

Instance Attribute Details

#__callbacks (readonly)

[ GitHub ]

# File 'activesupport/lib/active_support/callbacks.rb', line 67


class_attribute :__callbacks, instance_writer: false, default: {}

#__callbacks? ⇒ `Boolean` (readonly)

[ GitHub ]

# File 'activesupport/lib/active_support/callbacks.rb', line 67


class_attribute :__callbacks, instance_writer: false, default: {}

#active? ⇒ `Boolean` (readonly)

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.

[ GitHub ]

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


def active?
end

#in_use? (readonly)

Alias for #owner.

[ GitHub ]

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


alias :in_use? :owner

#lock (readonly)

[ GitHub ]

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


attr_reader :visitor, :owner, :logger, :lock

#logger (readonly)

[ GitHub ]

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


attr_reader :visitor, :owner, :logger, :lock

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

[ GitHub ]

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


attr_reader :visitor, :owner, :logger, :lock

#pool (rw)

[ GitHub ]

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


attr_accessor :pool

#prepared_statements (readonly)

Alias for #prepared_statements?.

[ GitHub ]

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


alias :prepared_statements :prepared_statements?

#preventing_writes? ⇒ `Boolean` (readonly)

Determines whether writes are currently being prevented.

Returns true if the connection is a replica.

If the application is using legacy handling, returns true if connection_handler.prevent_writes is set.

If the application is using the new connection handling will return true based on current_preventing_writes.

[ GitHub ]

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


def preventing_writes?
  return true if replica?
  return ActiveRecord::Base.connection_handler.prevent_writes if ActiveRecord::Base.legacy_connection_handling
  return false if connection_klass.nil?

  connection_klass.current_preventing_writes
end

#replica? ⇒ `Boolean` (readonly)

[ GitHub ]

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


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

#requires_reloading? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def requires_reloading?
  false
end

#schema_cache (rw)

[ GitHub ]

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


def schema_cache
  @pool.get_schema_cache(self)
end

#schema_cache=(cache) (rw)

[ GitHub ]

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


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

#supports_advisory_locks? ⇒ `Boolean` (readonly)

Does this adapter support application-enforced advisory locking?

[ GitHub ]

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


def supports_advisory_locks?
  false
end

#supports_bulk_alter? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_bulk_alter?
  false
end

#supports_check_constraints? ⇒ `Boolean` (readonly)

Does this adapter support creating check constraints?

[ GitHub ]

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


def supports_check_constraints?
  false
end

#supports_comments? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def supports_comments?
  false
end

#supports_comments_in_create? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def supports_comments_in_create?
  false
end

#supports_common_table_expressions? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_common_table_expressions?
  false
end

#supports_datetime_with_precision? ⇒ `Boolean` (readonly)

Does this adapter support datetime with precision?

[ GitHub ]

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


def supports_datetime_with_precision?
  false
end

#supports_ddl_transactions? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def supports_ddl_transactions?
  false
end

#supports_explain? ⇒ `Boolean` (readonly)

Does this adapter support explain?

[ GitHub ]

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


def supports_explain?
  false
end

#supports_expression_index? ⇒ `Boolean` (readonly)

Does this adapter support expression indices?

[ GitHub ]

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


def supports_expression_index?
  false
end

#supports_extensions? ⇒ `Boolean` (readonly)

Does this adapter support database extensions?

[ GitHub ]

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


def supports_extensions?
  false
end

#supports_foreign_keys? ⇒ `Boolean` (readonly)

Does this adapter support creating foreign key constraints?

[ GitHub ]

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


def supports_foreign_keys?
  false
end

#supports_foreign_tables? ⇒ `Boolean` (readonly)

Does this adapter support foreign/external tables?

[ GitHub ]

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


def supports_foreign_tables?
  false
end

#supports_index_sort_order? ⇒ `Boolean` (readonly)

Does this adapter support index sort order?

[ GitHub ]

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


def supports_index_sort_order?
  false
end

#supports_indexes_in_create? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def supports_indexes_in_create?
  false
end

#supports_insert_conflict_target? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_insert_conflict_target?
  false
end

#supports_insert_on_duplicate_skip? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_insert_on_duplicate_skip?
  false
end

#supports_insert_on_duplicate_update? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_insert_on_duplicate_update?
  false
end

#supports_insert_returning? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_insert_returning?
  false
end

#supports_json? ⇒ `Boolean` (readonly)

Does this adapter support json data type?

[ GitHub ]

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


def supports_json?
  false
end

#supports_lazy_transactions? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_lazy_transactions?
  false
end

#supports_materialized_views? ⇒ `Boolean` (readonly)

Does this adapter support materialized views?

[ GitHub ]

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


def supports_materialized_views?
  false
end

#supports_optimizer_hints? ⇒ `Boolean` (readonly)

Does this adapter support optimizer hints?

[ GitHub ]

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


def supports_optimizer_hints?
  false
end

#supports_partial_index? ⇒ `Boolean` (readonly)

Does this adapter support partial indices?

[ GitHub ]

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


def supports_partial_index?
  false
end

#supports_partitioned_indexes? ⇒ `Boolean` (readonly)

[ GitHub ]

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


def supports_partitioned_indexes?
  false
end

#supports_savepoints? ⇒ `Boolean` (readonly)

Does this adapter support savepoints?

[ GitHub ]

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


def supports_savepoints?
  false
end

#supports_transaction_isolation? ⇒ `Boolean` (readonly)

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

[ GitHub ]

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


def supports_transaction_isolation?
  false
end

#supports_validate_constraints? ⇒ `Boolean` (readonly)

Does this adapter support creating invalid constraints?

[ GitHub ]

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


def supports_validate_constraints?
  false
end

#supports_views? ⇒ `Boolean` (readonly)

Does this adapter support views?

[ GitHub ]

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


def supports_views?
  false
end

#supports_virtual_columns? ⇒ `Boolean` (readonly)

Does this adapter support virtual columns?

[ GitHub ]

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


def supports_virtual_columns?
  false
end

#use_metadata_table? ⇒ `Boolean` (readonly)

[ GitHub ]

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


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

#visitor (readonly)

[ GitHub ]

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


attr_reader :visitor, :owner, :logger, :lock

Instance Method Details

#adapter_name

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

[ GitHub ]

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


def adapter_name
  self.class::ADAPTER_NAME
end

#clear_cache!

Clear any caching the database adapter may be doing.

[ GitHub ]

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


def clear_cache!
  @lock.synchronize { @statements.clear } if @statements
end

#close

Check the connection back in to the connection pool

[ GitHub ]

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


def close
  pool.checkin self
end

#disable_extension(name)

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

[ GitHub ]

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


def disable_extension(name)
end

#disable_referential_integrity

Override to turn off referential integrity while executing &block.

[ GitHub ]

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


def disable_referential_integrity
  yield
end

#discard!

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.

[ GitHub ]

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


def discard!
  # This should be overridden by concrete adapters.
  #
  # Prevent @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!

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

[ GitHub ]

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


def disconnect!
  clear_cache!
  reset_transaction
end

#enable_extension(name)

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

[ GitHub ]

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


def enable_extension(name)
end

#expire

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

[ GitHub ]

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


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

    @idle_since = Concurrent.monotonic_time
    @owner = nil
  else
    raise ActiveRecordError, "Cannot expire connection, it is not currently leased."
  end
end

#extensions

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

[ GitHub ]

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


def extensions
  []
end

#index_algorithms

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

[ GitHub ]

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


def index_algorithms
  {}
end

#lease

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

[ GitHub ]

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


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

  @owner = Thread.current
end

#log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) (private)

[ GitHub ]

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


def log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) # :doc:
  @instrumenter.instrument(
    "sql.active_record",
    sql:               sql,
    name:              name,
    binds:             binds,
    type_casted_binds: type_casted_binds,
    statement_name:    statement_name,
    connection:        self) do
    @lock.synchronize do
      yield
    end
  rescue => e
    raise translate_exception_class(e, sql, binds)
  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.

[ GitHub ]

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


def prefetch_primary_key?(table_name = nil)
  false
end

#prepared_statements? ⇒ `Boolean` (readonly) Also known as: #prepared_statements

[ GitHub ]

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


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

#raw_connection

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.

[ GitHub ]

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


def raw_connection
  disable_lazy_transactions!
  @connection
end

#reconnect!

Disconnects from the database if already connected, and establishes a new connection with the database. Implementors should call super if they override the default implementation.

[ GitHub ]

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


def reconnect!
  clear_cache!
  reset_transaction
end

#reset!

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

The default implementation does nothing; the implementation should be overridden by concrete adapters.

[ GitHub ]

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


def reset!
  # this should be overridden by concrete adapters
end

#throw_away!

Removes the connection from the pool and disconnect it.

[ GitHub ]

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


def throw_away!
  pool.remove self
  disconnect!
end

#unprepared_statement

[ GitHub ]

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


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

#verify!

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.

[ GitHub ]

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


def verify!
  reconnect! unless active?
end

Class: ActiveRecord::ConnectionAdapters::AbstractAdapter

Overview

Constant Summary

::ActiveSupport::Callbacks - Included

DatabaseStatements - Included

Quoting - Included

::ActiveSupport::Callbacks - Attributes & Methods

Class Method Summary

::ActiveSupport::DescendantsTracker - self

Instance Attribute Summary

DatabaseStatements - Included

Instance Method Summary

Savepoints - Included

DatabaseLimits - Included

Quoting - Included

DatabaseStatements - Included

SchemaStatements - Included

::ActiveSupport::Callbacks - Included

Class Attribute Details

.__callbacks (rw)

.__callbacks? ⇒ Boolean (rw)

Class Method Details

.database_exists?(config) ⇒ Boolean

.type_cast_config_to_boolean(config)

.type_cast_config_to_integer(config)

Instance Attribute Details

#__callbacks (readonly)

#__callbacks? ⇒ Boolean (readonly)

#active? ⇒ Boolean (readonly)

#in_use? (readonly)

#lock (readonly)

#logger (readonly)

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

#pool (rw)

#prepared_statements (readonly)

#preventing_writes? ⇒ Boolean (readonly)

#replica? ⇒ Boolean (readonly)

#requires_reloading? ⇒ Boolean (readonly)

#schema_cache (rw)

#schema_cache=(cache) (rw)

#supports_advisory_locks? ⇒ Boolean (readonly)

#supports_bulk_alter? ⇒ Boolean (readonly)

#supports_check_constraints? ⇒ Boolean (readonly)

#supports_comments? ⇒ Boolean (readonly)

#supports_comments_in_create? ⇒ Boolean (readonly)

#supports_common_table_expressions? ⇒ Boolean (readonly)

#supports_datetime_with_precision? ⇒ Boolean (readonly)

#supports_ddl_transactions? ⇒ Boolean (readonly)

#supports_explain? ⇒ Boolean (readonly)

#supports_expression_index? ⇒ Boolean (readonly)

#supports_extensions? ⇒ Boolean (readonly)

#supports_foreign_keys? ⇒ Boolean (readonly)

#supports_foreign_tables? ⇒ Boolean (readonly)

#supports_index_sort_order? ⇒ Boolean (readonly)

#supports_indexes_in_create? ⇒ Boolean (readonly)

#supports_insert_conflict_target? ⇒ Boolean (readonly)

#supports_insert_on_duplicate_skip? ⇒ Boolean (readonly)

#supports_insert_on_duplicate_update? ⇒ Boolean (readonly)

#supports_insert_returning? ⇒ Boolean (readonly)

#supports_json? ⇒ Boolean (readonly)

#supports_lazy_transactions? ⇒ Boolean (readonly)

#supports_materialized_views? ⇒ Boolean (readonly)

#supports_optimizer_hints? ⇒ Boolean (readonly)

#supports_partial_index? ⇒ Boolean (readonly)

#supports_partitioned_indexes? ⇒ Boolean (readonly)

#supports_savepoints? ⇒ Boolean (readonly)

#supports_transaction_isolation? ⇒ Boolean (readonly)

#supports_validate_constraints? ⇒ Boolean (readonly)

#supports_views? ⇒ Boolean (readonly)

#supports_virtual_columns? ⇒ Boolean (readonly)

#use_metadata_table? ⇒ Boolean (readonly)

#visitor (readonly)

Instance Method Details

#adapter_name

#clear_cache!

#close

#disable_extension(name)

#disable_referential_integrity

#discard!

#disconnect!

`::ActiveSupport::Callbacks` - Included

`DatabaseStatements` - Included

`Quoting` - Included

`::ActiveSupport::Callbacks` - Attributes & Methods

`::ActiveSupport::DescendantsTracker` - self

`DatabaseStatements` - Included

`Savepoints` - Included

`DatabaseLimits` - Included

`Quoting` - Included

`DatabaseStatements` - Included

`SchemaStatements` - Included

`::ActiveSupport::Callbacks` - Included

.__callbacks? ⇒ `Boolean` (rw)

.database_exists?(config) ⇒ `Boolean`

#__callbacks? ⇒ `Boolean` (readonly)

#active? ⇒ `Boolean` (readonly)

#preventing_writes? ⇒ `Boolean` (readonly)

#replica? ⇒ `Boolean` (readonly)

#requires_reloading? ⇒ `Boolean` (readonly)

#supports_advisory_locks? ⇒ `Boolean` (readonly)

#supports_bulk_alter? ⇒ `Boolean` (readonly)

#supports_check_constraints? ⇒ `Boolean` (readonly)

#supports_comments? ⇒ `Boolean` (readonly)

#supports_comments_in_create? ⇒ `Boolean` (readonly)

#supports_common_table_expressions? ⇒ `Boolean` (readonly)

#supports_datetime_with_precision? ⇒ `Boolean` (readonly)

#supports_ddl_transactions? ⇒ `Boolean` (readonly)

#supports_explain? ⇒ `Boolean` (readonly)

#supports_expression_index? ⇒ `Boolean` (readonly)

#supports_extensions? ⇒ `Boolean` (readonly)

#supports_foreign_keys? ⇒ `Boolean` (readonly)

#supports_foreign_tables? ⇒ `Boolean` (readonly)

#supports_index_sort_order? ⇒ `Boolean` (readonly)

#supports_indexes_in_create? ⇒ `Boolean` (readonly)

#supports_insert_conflict_target? ⇒ `Boolean` (readonly)

#supports_insert_on_duplicate_skip? ⇒ `Boolean` (readonly)

#supports_insert_on_duplicate_update? ⇒ `Boolean` (readonly)

#supports_insert_returning? ⇒ `Boolean` (readonly)

#supports_json? ⇒ `Boolean` (readonly)

#supports_lazy_transactions? ⇒ `Boolean` (readonly)

#supports_materialized_views? ⇒ `Boolean` (readonly)

#supports_optimizer_hints? ⇒ `Boolean` (readonly)

#supports_partial_index? ⇒ `Boolean` (readonly)

#supports_partitioned_indexes? ⇒ `Boolean` (readonly)

#supports_savepoints? ⇒ `Boolean` (readonly)

#supports_transaction_isolation? ⇒ `Boolean` (readonly)

#supports_validate_constraints? ⇒ `Boolean` (readonly)

#supports_views? ⇒ `Boolean` (readonly)

#supports_virtual_columns? ⇒ `Boolean` (readonly)

#use_metadata_table? ⇒ `Boolean` (readonly)

#prefetch_primary_key?(table_name = nil) ⇒ `Boolean`

#prepared_statements? ⇒ `Boolean` (readonly) Also known as: #prepared_statements