класс 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]

prepared_statements[R]

schema_cache[R]

visitor[RW]

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

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

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 91
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 83
def self.type_cast_config_to_integer(config)
  if config =~ SIMPLE_INT
    config.to_i
  else
    config
  end
end

Публичные методы экземпляра

active?() Show source

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

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

adapter_name() Show source

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

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

clear_cache!() Show source

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

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

close() Show source

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

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

disable_extension(name) Show source

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

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

disable_referential_integrity() { || ... } Show source

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

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

discard!() Show source

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

Немедленно забывает о существовании этого соединения. В отличие от disconnect!, этот метод не будет взаимодействовать с сервером.

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

disconnect!() Show source

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

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

enable_extension(name) Show source

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

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

expire() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 168
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() Show source

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

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

index_algorithms() Show source

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

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

lease() Show source

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 147
def lease
  if in_use?
    msg = "Cannot lease connection, ".dup
    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) Show source

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

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

raw_connection() Show source

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

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

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

reconnect!() Show source

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

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

requires_reloading?() Show source

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

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

reset!() Show source

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

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

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

schema_cache=(cache) Show source

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

supports_advisory_locks?() Show source

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

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

supports_bulk_alter?() Show source

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

supports_comments?() Show source

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

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

supports_comments_in_create?() Show source

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

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

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

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

Поддерживает ли этот адаптер тип datetime с точностью?

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 202
def unprepared_statement
  old_prepared_statements, @prepared_statements = @prepared_statements, false
  yield
ensure
  @prepared_statements = old_prepared_statements
end

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

# File activerecord/lib/active_record/connection_adapters/abstract_adapter.rb, line 434
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 568
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) do
    begin
      @lock.synchronize do
        yield
      end
    rescue => e
      raise translate_exception_class(e, sql)
    end
  end
end