класс ActiveRecord::ConnectionAdapters::AbstractAdapter

Родитель:: Объект
Включенные модули:: ActiveSupport::Callbacks, ActiveRecord::ConnectionAdapters::Quoting, ActiveRecord::ConnectionAdapters::DatabaseStatements, ActiveRecord::ConnectionAdapters::SchemaStatements, ActiveRecord::ConnectionAdapters::DatabaseLimits, ActiveRecord::ConnectionAdapters::QueryCache, ActiveRecord::ConnectionAdapters::Savepoints

Active Record поддерживает множество систем баз данных. AbstractAdapter и связанные классы образуют абстракционный слой, что делает это возможным. AbstractAdapter представляет собой подключение к базе данных и предоставляет абстрактный интерфейс для функций, специфичных для базы данных, таких как установление подключения, экранирование значений, построение правильных фрагментов SQL для :offset и :limit опций и т. д.

Все конкретные адаптеры баз данных следуют интерфейсу, заданному в этом классе. ActiveRecord::Base.connection возвращает объект AbstractAdapter, который вы можете использовать.

Большинство методов в адаптере полезны во время миграций. В частности, методы экземпляра, предоставляемые SchemaStatements, очень полезны.

Константы

ADAPTER_NAME
SIMPLE_INT

Атрибуты

in_use?[R]

lock[R]

logger[R]

owner[R]

pool[RW]

visitor[R]

Публичные методы класса

database_exists?(config) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 277
def self.database_exists?(config)
  raise NotImplementedError
end

Существует ли база данных для данного адаптера?

type_cast_config_to_boolean(config) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 97
def self.type_cast_config_to_boolean(config)
  if config == "false"
    false
  else
    config
  end
end

type_cast_config_to_integer(config) Показать исходный код

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

Открытые методы экземпляра

active?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 480
def active?
end

Проверяет, активно ли соединение с базой данных. Это включает проверку того, способна ли база данных фактически отвечать, т. е. не устарело ли соединение.

adapter_name() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 272
def adapter_name
  self.class::ADAPTER_NAME
end

Возвращает понятное имя адаптера. Используйте регистр в стиле «Верблюжий горб» — при необходимости всегда можно использовать нижний регистр.

clear_cache!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 525
def clear_cache!
  @lock.synchronize { @statements.clear } if @statements
end

Очищает любой кэш, который может использовать адаптер базы данных.

close() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 576
def close
  pool.checkin self
end

Возвращает соединение в пул соединений

disable_extension(name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 433
def disable_extension(name)
end

Предназначен для реализации адаптерами, которые поддерживают расширения

disable_referential_integrity() { || ... } Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 471
def disable_referential_integrity
  yield
end

Переопределить, чтобы отключить целостность ссылок при выполнении &block.

discard!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 504
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!, это не будет взаимодействовать с сервером.

После вызова этого метода поведение всех остальных методов становится неопределенным. Это вызывается внутренне непосредственно перед тем, как разветвленный процесс избавляется от соединения, принадлежавшего его родителю.

disconnect!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 493
def disconnect!
  clear_cache!
  reset_transaction
end

Отключается от базы данных, если уже подключено. В противном случае этот метод ничего не делает.

enable_extension(name) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 437
def enable_extension(name)
end

Предназначен для реализации адаптерами, которые поддерживают расширения

expire() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 232
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() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 459
def extensions
  []
end

Список расширений, который должен заполняться адаптерами, которые их поддерживают.

index_algorithms() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 464
def index_algorithms
  {}
end

Список алгоритмов индексирования, который должен заполняться адаптерами, которые их поддерживают.

lease() Показать исходный код

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

этот метод должен вызываться только при удержании мьютекса пула соединений

prefetch_primary_key?(table_name = nil) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 304
def prefetch_primary_key?(table_name = nil)
  false
end

Следует ли выбирать значения первичных ключей из соответствующей последовательности перед инструкцией вставки? Если true, то next_sequence_value вызывается перед каждой вставкой для установки первичного ключа записи.

prepared_statements() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 179
def prepared_statements
  @prepared_statement_status.value
end

preventing_writes?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 152
def preventing_writes?
  replica? || ActiveRecord::Base.connection_handler.prevent_writes
end

Определяет, предотвращаются ли в настоящее время записи.

Возвращает true, если соединение является репликой, или если prevent_writes установлено в true.

raw_connection() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 547
def raw_connection
  disable_lazy_transactions!
  @connection
end

Обеспечивает доступ к базовому драйверу базы данных для этого адаптера. Например, этот метод возвращает объект Mysql2::Client в случае Mysql2Adapter и объект PG::Connection в случае PostgreSQLAdapter.

Это полезно, когда вам нужно вызвать собственный метод, например, методы lo_* PostgreSQL.

reconnect!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 486
def reconnect!
  clear_cache!
  reset_transaction
end

Отключается от базы данных, если уже подключено, и устанавливает новое соединение с базой данных. Разработчики должны вызвать super, если они переопределяют реализацию по умолчанию.

replica?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 144
def replica?
  @config[:replica] || false
end

requires_reloading?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 530
def requires_reloading?
  false
end

Возвращает true, если необходимо перезагрузить соединение между запросами для режима разработки.

reset!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 520
def reset!
  # this should be overridden by concrete adapters
end

Сбросить состояние этого соединения, направив СУБД очистить транзакции и другое состояние сервера, связанное с соединением. Обычно операция, зависящая от базы данных.

Реализация по умолчанию ничего не делает; реализация должна быть переопределена конкретными адаптерами.

schema_cache() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 222
def schema_cache
  @pool.get_schema_cache(self)
end

schema_cache=(cache) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 226
def schema_cache=(cache)
  cache.connection = self
  @pool.set_schema_cache(cache)
end

supports_advisory_locks?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 297
def supports_advisory_locks?
  false
end

Поддерживает ли этот адаптер блокировку на уровне приложения?

supports_bulk_alter?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 287
def supports_bulk_alter?
  false
end

supports_comments?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 382
def supports_comments?
  false
end

Поддерживает ли этот адаптер метаданные комментариев к объектам базы данных (таблицам, столбцам, индексам)?

supports_comments_in_create?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 387
def supports_comments_in_create?
  false
end

Можно ли указывать комментарии для таблиц, столбцов и индексов в операторах create/alter table?

supports_datetime_with_precision?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 372
def supports_datetime_with_precision?
  false
end

Поддерживает ли этот адаптер тип данных datetime с указанием точности?

supports_ddl_transactions?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 283
def supports_ddl_transactions?
  false
end

Поддерживает ли этот адаптер откат DDL-операций в транзакциях? То есть, будут ли операции CREATE TABLE или ALTER TABLE откатаны транзакцией?

supports_explain?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 324
def supports_explain?
  false
end

Поддерживает ли этот адаптер explain?

supports_expression_index?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 319
def supports_expression_index?
  false
end

Поддерживает ли этот адаптер индексы выражений?

supports_extensions?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 334
def supports_extensions?
  false
end

Поддерживает ли этот адаптер расширения базы данных?

supports_foreign_keys?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 345
def supports_foreign_keys?
  false
end

Поддерживает ли этот адаптер создание ограничений внешнего ключа?

supports_foreign_keys_in_create?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 356
def supports_foreign_keys_in_create?
  supports_foreign_keys?
end

Поддерживает ли этот адаптер создание ограничений внешнего ключа в том же операторе, что и создание таблицы?

supports_foreign_tables?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 403
def supports_foreign_tables?
  false
end

Поддерживает ли этот адаптер внешние таблицы?

supports_index_sort_order?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 309
def supports_index_sort_order?
  false
end

Поддерживает ли этот адаптер порядок сортировки индекса?

supports_indexes_in_create?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 340
def supports_indexes_in_create?
  false
end

Поддерживает ли этот адаптер создание индексов в том же операторе, что и создание таблицы?

supports_insert_conflict_target?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 428
def supports_insert_conflict_target?
  false
end

supports_insert_on_duplicate_skip?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 420
def supports_insert_on_duplicate_skip?
  false
end

supports_insert_on_duplicate_update?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 424
def supports_insert_on_duplicate_update?
  false
end

supports_insert_returning?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 416
def supports_insert_returning?
  false
end

supports_json?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 377
def supports_json?
  false
end

Поддерживает ли этот адаптер тип данных json?

supports_lazy_transactions?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 412
def supports_lazy_transactions?
  false
end

supports_materialized_views?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 367
def supports_materialized_views?
  false
end

Поддерживает ли этот адаптер материализованные представления?

supports_multi_insert?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 392
def supports_multi_insert?
  true
end

Поддерживает ли этот адаптер многозначную вставку?

supports_optimizer_hints?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 408
def supports_optimizer_hints?
  false
end

Поддерживает ли этот адаптер подсказки оптимизатора?

supports_partial_index?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 314
def supports_partial_index?
  false
end

Поддерживает ли этот адаптер частичные индексы?

supports_savepoints?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 292
def supports_savepoints?
  false
end

Поддерживает ли этот адаптер точки сохранения?

supports_transaction_isolation?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 329
def supports_transaction_isolation?
  false
end

Поддерживает ли этот адаптер установку уровня изоляции для транзакции?

supports_validate_constraints?() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 350
def supports_validate_constraints?
  false
end

Поддерживает ли этот адаптер создание недействительных ограничений?

supports_views?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 362
def supports_views?
  false
end

Поддерживает ли этот адаптер представления?

supports_virtual_columns?() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 398
def supports_virtual_columns?
  false
end

Поддерживает ли этот адаптер виртуальные столбцы?

unprepared_statement() { || ... } Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 266
def unprepared_statement
  @prepared_statement_status.bind(false) { yield }
end

verify!() Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 537
def verify!
  reconnect! unless active?
end

Проверяет, активен ли (то есть не устарел) подключение к базе данных. Это делается в скрытом режиме вызовом active?. Если подключение больше не активно, этот метод переподключится к базе данных.

Методы частного экземпляра

log(sql, name = "SQL", binds = [], type_casted_binds = [], statement_name = nil) { || ... } Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 696
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_id:     object_id,
    connection:        self) do
    @lock.synchronize do
      yield
    end
  rescue => e
    raise translate_exception_class(e, sql, binds)
  end
end