модуль ActiveRecord::ConnectionAdapters::DatabaseStatements

Открытые методы класса

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 6
def initialize
  super
  reset_transaction
end

Вызывает метод суперкласса

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

add_transaction_record(record) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 299
def add_transaction_record(record)
  current_transaction.add_record(record)
end

Регистрирует запись в текущей транзакции, чтобы можно было вызвать её обратные вызовы after_commit и after_rollback.

begin_db_transaction() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 308
def begin_db_transaction()    end

Начинает транзакцию (и отключает автоматическую фиксацию).

begin_isolated_db_transaction(isolation) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 322
def begin_isolated_db_transaction(isolation)
  raise ActiveRecord::TransactionIsolationError, "adapter does not support setting transaction isolation"
end

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

commit_db_transaction() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 327
def commit_db_transaction()   end

Фиксирует транзакцию (и включает автоматическую фиксацию).

create(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [])

Псевдоним для: insert

default_sequence_name(table, column) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 341
def default_sequence_name(table, column)
  nil
end

delete(arel, name = nil, binds = []) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 174
def delete(arel, name = nil, binds = [])
  sql, binds = to_sql_and_binds(arel, binds)
  exec_delete(sql, name, binds)
end

Выполняет оператор удаления и возвращает количество затронутых строк.

empty_insert_statement_value(primary_key = nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 375
def empty_insert_statement_value(primary_key = nil)
  "DEFAULT VALUES"
end

exec_delete(sql, name = nil, binds = []) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 141
def exec_delete(sql, name = nil, binds = [])
  exec_query(sql, name, binds)
end

Выполняет оператор удаления sql в контексте этого соединения, используя binds в качестве подстановок для привязки. name регистрируется вместе с выполненным оператором sql.

exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 133
def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil)
  sql, binds = sql_for_insert(sql, pk, binds)
  exec_query(sql, name, binds)
end

Выполняет оператор вставки sql в контексте этого соединения, используя binds в качестве подстановок для привязки. name регистрируется вместе с выполненным оператором sql.

exec_query(sql, name = "SQL", binds = [], prepare: false) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 126
def exec_query(sql, name = "SQL", binds = [], prepare: false)
  raise NotImplementedError
end

Выполняет оператор sql в контексте этого соединения, используя binds в качестве подстановок для привязки. name регистрируется вместе с выполненным оператором sql.

exec_update(sql, name = nil, binds = []) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 148
def exec_update(sql, name = nil, binds = [])
  exec_query(sql, name, binds)
end

Выполняет оператор обновления sql в контексте этого соединения, используя binds в качестве подстановок для привязки. name регистрируется вместе с выполненным оператором sql.

execute(sql, name = nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 119
def execute(sql, name = nil)
  raise NotImplementedError
end

Выполняет оператор SQL в контексте этого соединения и возвращает необработанный результат из адаптера соединения. Примечание: в зависимости от вашего коннектора базы данных, результат, возвращаемый этим методом, может управляться вручную в памяти. Вместо этого рассмотрите использование оболочки #exec_query.

insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = []) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 160
def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [])
  sql, binds = to_sql_and_binds(arel, binds)
  value = exec_insert(sql, name, binds, pk, sequence_name)
  id_value || last_inserted_id(value)
end

Выполняет запрос INSERT и возвращает ID новой записи

id_value будет возвращено, если значение не nil, в этом случае база данных попытается вычислить последний вставленный ID и вернуть это значение.

Если следующий ID был вычислен заранее (как в Oracle), его следует передать как id_value.

Также является псевдонимом для: create

insert_fixture(fixture, table_name) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 355
def insert_fixture(fixture, table_name)
  execute(build_fixture_sql(Array.wrap(fixture), table_name), "Fixture Insert")
end

Вставляет заданный фикстуру в таблицу. Переопределено в адаптерах, которые требуют чего-то большего, чем простая вставка (например, Oracle). Большинство адаптеров должны реализовать `insert_fixtures_set`, который использует массовую вставку SQL. Мы сохраняем этот метод, чтобы обеспечить резервное копирование для таких баз данных, как sqlite, которые не поддерживают массовые вставки.

insert_fixtures_set(fixture_set, tables_to_delete = []) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 359
def insert_fixtures_set(fixture_set, tables_to_delete = [])
  fixture_inserts = build_fixture_statements(fixture_set)
  table_deletes = tables_to_delete.map { |table| "DELETE FROM #{quote_table_name(table)}" }
  total_sql = Array(combine_multi_statements(table_deletes + fixture_inserts))

  with_multi_statements do
    disable_referential_integrity do
      transaction(requires_new: true) do
        total_sql.each do |sql|
          execute_batch(sql, "Fixtures Load")
        end
      end
    end
  end
end

reset_sequence!(table, column, sequence = nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 346
def reset_sequence!(table, column, sequence = nil)
  # Do nothing by default. Implement for PostgreSQL, Oracle, ...
end

Устанавливает последовательность в максимальное значение столбца таблицы.

rollback_db_transaction() Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 331
def rollback_db_transaction
  exec_rollback_db_transaction
end

Откатывает транзакцию (и включает автоматическую фиксацию). Это необходимо сделать, если блок транзакции вызывает исключение или возвращает false.

rollback_to_savepoint(name = nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 337
def rollback_to_savepoint(name = nil)
  exec_rollback_to_savepoint(name)
end

sanitize_limit(limit) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 385
def sanitize_limit(limit)
  if limit.is_a?(Integer) || limit.is_a?(Arel::Nodes::SqlLiteral)
    limit
  else
    Integer(limit)
  end
end

Очищает заданный параметр LIMIT, чтобы предотвратить SQL-инъекцию.

limit может быть чем угодно, что может быть преобразовано в строку с помощью to_s. Он должен выглядеть как целое число или литерал Arel SQL.

Возвращает Integer и Arel::Nodes::SqlLiteral лимиты как есть.

select_all(arel, name = nil, binds = [], preparable: nil) Show source

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 59
def select_all(arel, name = nil, binds = [], preparable: nil)
  arel = arel_from_relation(arel)
  sql, binds = to_sql_and_binds(arel, binds)

  if preparable.nil?
    preparable = prepared_statements ? visitor.preparable : false
  end

  if prepared_statements && preparable
    select_prepared(sql, name, binds)
  else
    select(sql, name, binds)
  end
end

Возвращает экземпляр ActiveRecord::Result.

select_one(arel, name = nil, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 76
def select_one(arel, name = nil, binds = [])
  select_all(arel, name, binds).first
end

Возвращает хеш записи со столбцами в качестве ключей и значениями столбцов.

select_rows(arel, name = nil, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 93
def select_rows(arel, name = nil, binds = [])
  select_all(arel, name, binds).rows
end

Возвращает массив массивов, содержащих значения полей. Порядок соответствует порядку, возвращаемому columns.

select_value(arel, name = nil, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 81
def select_value(arel, name = nil, binds = [])
  single_value_from_rows(select_rows(arel, name, binds))
end

Возвращает одно значение из записи.

select_values(arel, name = nil, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 87
def select_values(arel, name = nil, binds = [])
  select_rows(arel, name, binds).map(&:first)
end

Возвращает массив значений первого столбца в запросе:

select_values("SELECT id FROM companies LIMIT 3") => [1,2,3]

to_sql(arel_or_sql_string, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 12
def to_sql(arel_or_sql_string, binds = [])
  sql, _ = to_sql_and_binds(arel_or_sql_string, binds)
  sql
end

Преобразует AST запроса Arel в SQL.

transaction(requires_new: nil, isolation: nil, joinable: true) { || ... } Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 270
def transaction(requires_new: nil, isolation: nil, joinable: true)
  if !requires_new && current_transaction.joinable?
    if isolation
      raise ActiveRecord::TransactionIsolationError, "cannot set isolation when joining a transaction"
    end
    yield
  else
    transaction_manager.within_new_transaction(isolation: isolation, joinable: joinable) { yield }
  end
rescue ActiveRecord::Rollback
  # rollbacks are silently swallowed
end

Выполняет заданный блок в транзакции базы данных и возвращает результат блока.

Поддержка вложенных транзакций

Большинство баз данных не поддерживают истинные вложенные транзакции. На момент написания, единственная база данных, о которой нам известно, поддерживающая истинные вложенные транзакции, — это MS-SQL.

Для решения этой проблемы, transaction эмулирует эффект вложенных транзакций, используя сохраняемые точки: dev.mysql.com/doc/refman/5.7/en/savepoint.html Сохраняемые точки поддерживаются MySQL и PostgreSQL. SQLite3 версии >= '3.6.8' поддерживает сохраняемые точки.

Безопасно вызывать этот метод, если транзакция базы данных уже открыта, т.е. если transaction вызывается внутри другого блока transaction. В случае вложенного вызова transaction будет действовать следующим образом:

Блок будет выполнен без каких-либо действий. Все операторы базы данных, выполняемые внутри блока, фактически добавляются к уже открытой транзакции базы данных.
Однако, если :requires_new установлено, блок будет заключён в сохраняемую точку базы данных, выступающую в качестве подтранзакции.

Ограничения

MySQL не поддерживает транзакции DDL. Если вы выполните операцию DDL, то все созданные сохраняемые точки будут автоматически освобождены. Например, если вы создали сохраняемую точку, затем выполнили оператор CREATE TABLE, то созданная сохраняемая точка будет автоматически освобождена.

Это означает, что в MySQL не следует выполнять операции DDL внутри вызова transaction, если известно, что они могут создать сохраняемую точку. В противном случае transaction будет генерировать исключения при попытке освободить уже автоматически освобождённые сохраняемые точки:

Model.connection.transaction do  # BEGIN
  Model.connection.transaction(requires_new: true) do  # CREATE SAVEPOINT active_record_1
    Model.connection.create_table(...)
    # active_record_1 now automatically released
  end  # RELEASE SAVEPOINT active_record_1  <--- BOOM! database error!
end

Изоляция транзакций

Если ваша база данных поддерживает установку уровня изоляции для транзакции, вы можете установить её так:

Post.transaction(isolation: :serializable) do
  # ...
end

Допустимые уровни изоляции:

:read_uncommitted
:read_committed
:repeatable_read
:serializable

Обратитесь к документации вашей базы данных, чтобы понять семантику этих различных уровней:

Исключение ActiveRecord::TransactionIsolationError будет выброшено, если:

Адаптер не поддерживает настройку уровня изоляции
Вы присоединяетесь к уже открытой транзакции
Вы создаёте вложенную (с сохраняемой точкой) транзакцию

Адаптеры mysql2 и postgresql поддерживают установку уровня изоляции транзакции.

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

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 310
def transaction_isolation_levels
  {
    read_uncommitted: "READ UNCOMMITTED",
    read_committed:   "READ COMMITTED",
    repeatable_read:  "REPEATABLE READ",
    serializable:     "SERIALIZABLE"
  }
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 289
def transaction_open?
  current_transaction.open?
end

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

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 303
def transaction_state
  current_transaction.state
end

truncate(table_name, name = nil) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 180
def truncate(table_name, name = nil)
  execute(build_truncate_statements(table_name), name)
end

Выполняет оператор truncate.

update(arel, name = nil, binds = []) Показать исходный код

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 168
def update(arel, name = nil, binds = [])
  sql, binds = to_sql_and_binds(arel, binds)
  exec_update(sql, name, binds)
end

Выполняет оператор update и возвращает количество изменённых строк.

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

# File activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb, line 110
def write_query?(sql)
  raise NotImplementedError
end

Определяет, является ли SQL-запрос запросом записи.