Module: ActiveRecord::ConnectionAdapters::DatabaseStatements
- Included in:
- AbstractAdapter
- Defined in:
- activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb
Instance Attribute Summary collapse
-
#transaction_manager ⇒ Object
readonly
:nodoc:.
Instance Method Summary collapse
-
#add_transaction_record(record, ensure_finalize = true) ⇒ Object
Register a record with the current transaction so that its after_commit and after_rollback callbacks can be called.
-
#begin_db_transaction ⇒ Object
Begins the transaction (and turns off auto-committing).
-
#begin_deferred_transaction(isolation_level = nil) ⇒ Object
:nodoc:.
-
#begin_isolated_db_transaction(isolation) ⇒ Object
Begins the transaction with the isolation level set.
-
#cacheable_query(klass, arel) ⇒ Object
This is used in the StatementCache object.
-
#commit_db_transaction ⇒ Object
Commits the transaction (and turns on auto-committing).
-
#default_insert_value(column) ⇒ Object
:nodoc:.
- #default_sequence_name(table, column) ⇒ Object
-
#delete(arel, name = nil, binds = []) ⇒ Object
Executes the delete statement and returns the number of rows affected.
- #empty_insert_statement_value(primary_key = nil) ⇒ Object
-
#exec_delete(sql, name = nil, binds = []) ⇒ Object
Executes delete
sql
statement in the context of this connection usingbinds
as the bind substitutes. -
#exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) ⇒ Object
Executes insert
sql
statement in the context of this connection usingbinds
as the bind substitutes. -
#exec_insert_all(sql, name) ⇒ Object
:nodoc:.
-
#exec_query(sql, name = "SQL", binds = [], prepare: false) ⇒ Object
Executes
sql
statement in the context of this connection usingbinds
as the bind substitutes. -
#exec_restart_db_transaction ⇒ Object
:nodoc:.
-
#exec_rollback_db_transaction ⇒ Object
:nodoc:.
-
#exec_update(sql, name = nil, binds = []) ⇒ Object
Executes update
sql
statement in the context of this connection usingbinds
as the bind substitutes. -
#execute(sql, name = nil, allow_retry: false) ⇒ Object
Executes the SQL statement in the context of this connection and returns the raw result from the connection adapter.
-
#explain(arel, binds = [], options = []) ⇒ Object
:nodoc:.
-
#high_precision_current_timestamp ⇒ Object
Returns an Arel SQL literal for the CURRENT_TIMESTAMP for usage with arbitrary precision date/time columns.
- #initialize ⇒ Object
-
#insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [], returning: nil) ⇒ Object
(also: #create)
Executes an INSERT query and returns the new record’s ID.
-
#insert_fixture(fixture, table_name) ⇒ Object
Inserts the given fixture into the table.
- #insert_fixtures_set(fixture_set, tables_to_delete = []) ⇒ Object
-
#internal_exec_query ⇒ Object
Execute a query and returns an ActiveRecord::Result.
-
#mark_transaction_written_if_write(sql) ⇒ Object
:nodoc:.
-
#query(sql, name = nil, allow_retry: true, materialize_transactions: true) ⇒ Object
:nodoc:.
-
#query_value ⇒ Object
:nodoc:.
-
#query_values ⇒ Object
:nodoc:.
-
#raw_exec_query ⇒ Object
Same as raw_execute but returns an ActiveRecord::Result object.
-
#reset_isolation_level ⇒ Object
Hook point called after an isolated DB transaction is committed or rolled back.
-
#reset_sequence!(table, column, sequence = nil) ⇒ Object
Set the sequence to the max value of the table’s column.
-
#reset_transaction(restore: false) ⇒ Object
:nodoc:.
- #restart_db_transaction ⇒ Object
-
#rollback_db_transaction ⇒ Object
Rolls back the transaction (and turns on auto-committing).
- #rollback_to_savepoint(name = nil) ⇒ Object
-
#sanitize_limit(limit) ⇒ Object
Sanitizes the given LIMIT parameter in order to prevent SQL injection.
-
#select_all(arel, name = nil, binds = [], preparable: nil, async: false, allow_retry: false) ⇒ Object
Returns an ActiveRecord::Result instance.
-
#select_one(arel, name = nil, binds = [], async: false) ⇒ Object
Returns a record hash with the column names as keys and column values as values.
-
#select_rows(arel, name = nil, binds = [], async: false) ⇒ Object
Returns an array of arrays containing the field values.
-
#select_value(arel, name = nil, binds = [], async: false) ⇒ Object
Returns a single value from a record.
-
#select_values(arel, name = nil, binds = []) ⇒ Object
Returns an array of the values of the first column in a select: select_values(“SELECT id FROM companies LIMIT 3”) => [1,2,3].
-
#to_sql(arel_or_sql_string, binds = []) ⇒ Object
Converts an arel AST to SQL.
-
#transaction(requires_new: nil, isolation: nil, joinable: true, &block) ⇒ Object
Runs the given block in a database transaction, and returns the result of the block.
- #transaction_isolation_levels ⇒ Object
- #transaction_open? ⇒ Boolean
-
#truncate(table_name, name = nil) ⇒ Object
Executes the truncate statement.
-
#truncate_tables(*table_names) ⇒ Object
:nodoc:.
-
#update(arel, name = nil, binds = []) ⇒ Object
Executes the update statement and returns the number of rows affected.
-
#with_yaml_fallback(value) ⇒ Object
Fixture value is quoted by Arel, however scalar values are not quotable.
-
#write_query?(sql) ⇒ Boolean
Determines whether the SQL statement is a write query.
Instance Attribute Details
#transaction_manager ⇒ Object (readonly)
:nodoc:
368 369 370 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 368 def transaction_manager @transaction_manager end |
Instance Method Details
#add_transaction_record(record, ensure_finalize = true) ⇒ Object
Register a record with the current transaction so that its after_commit and after_rollback callbacks can be called.
408 409 410 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 408 def add_transaction_record(record, ensure_finalize = true) current_transaction.add_record(record, ensure_finalize) end |
#begin_db_transaction ⇒ Object
Begins the transaction (and turns off auto-committing).
413 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 413 def begin_db_transaction() end |
#begin_deferred_transaction(isolation_level = nil) ⇒ Object
:nodoc:
415 416 417 418 419 420 421 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 415 def begin_deferred_transaction(isolation_level = nil) # :nodoc: if isolation_level begin_isolated_db_transaction(isolation_level) else begin_db_transaction end end |
#begin_isolated_db_transaction(isolation) ⇒ Object
Begins the transaction with the isolation level set. Raises an error by default; adapters that support setting the isolation level should implement this method.
435 436 437 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 435 def begin_isolated_db_transaction(isolation) raise ActiveRecord::TransactionIsolationError, "adapter does not support setting transaction isolation" end |
#cacheable_query(klass, arel) ⇒ Object
This is used in the StatementCache object. It returns an object that can be used to query the database repeatedly.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 56 def cacheable_query(klass, arel) # :nodoc: if prepared_statements collector = collector() collector.retryable = true sql, binds = visitor.compile(arel.ast, collector) query = klass.query(sql, retryable: collector.retryable) else collector = klass.partial_query_collector collector.retryable = true parts, binds = visitor.compile(arel.ast, collector) query = klass.partial_query(parts, retryable: collector.retryable) end [query, binds] end |
#commit_db_transaction ⇒ Object
Commits the transaction (and turns on auto-committing).
449 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 449 def commit_db_transaction() end |
#default_insert_value(column) ⇒ Object
:nodoc:
553 554 555 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 553 def default_insert_value(column) # :nodoc: DEFAULT_INSERT_VALUE end |
#default_sequence_name(table, column) ⇒ Object
471 472 473 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 471 def default_sequence_name(table, column) nil end |
#delete(arel, name = nil, binds = []) ⇒ Object
Executes the delete statement and returns the number of rows affected.
215 216 217 218 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 215 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) ⇒ Object
501 502 503 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 501 def empty_insert_statement_value(primary_key = nil) "DEFAULT VALUES" end |
#exec_delete(sql, name = nil, binds = []) ⇒ Object
Executes delete sql
statement in the context of this connection using binds
as the bind substitutes. name
is logged along with the executed sql
statement.
168 169 170 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 168 def exec_delete(sql, name = nil, binds = []) affected_rows(internal_execute(sql, name, binds)) end |
#exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) ⇒ Object
Executes insert sql
statement in the context of this connection using binds
as the bind substitutes. name
is logged along with the executed sql
statement. Some adapters support the ‘returning` keyword argument which allows to control the result of the query: `nil` is the default value and maintains default behavior. If an array of column names is passed - the result will contain values of the specified columns from the inserted row.
160 161 162 163 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 160 def exec_insert(sql, name = nil, binds = [], pk = nil, sequence_name = nil, returning: nil) sql, binds = sql_for_insert(sql, pk, binds, returning) internal_exec_query(sql, name, binds) end |
#exec_insert_all(sql, name) ⇒ Object
:nodoc:
179 180 181 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 179 def exec_insert_all(sql, name) # :nodoc: internal_exec_query(sql, name) end |
#exec_query(sql, name = "SQL", binds = [], prepare: false) ⇒ Object
Executes sql
statement in the context of this connection using binds
as the bind substitutes. name
is logged along with the executed sql
statement.
Note: the query is assumed to have side effects and the query cache will be cleared. If the query is read-only, consider using #select_all instead.
150 151 152 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 150 def exec_query(sql, name = "SQL", binds = [], prepare: false) internal_exec_query(sql, name, binds, prepare: prepare) end |
#exec_restart_db_transaction ⇒ Object
:nodoc:
465 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 465 def exec_restart_db_transaction() end |
#exec_rollback_db_transaction ⇒ Object
:nodoc:
459 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 459 def exec_rollback_db_transaction() end |
#exec_update(sql, name = nil, binds = []) ⇒ Object
Executes update sql
statement in the context of this connection using binds
as the bind substitutes. name
is logged along with the executed sql
statement.
175 176 177 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 175 def exec_update(sql, name = nil, binds = []) affected_rows(internal_execute(sql, name, binds)) end |
#execute(sql, name = nil, allow_retry: false) ⇒ Object
Executes the SQL statement in the context of this connection and returns the raw result from the connection adapter.
Setting allow_retry
to true causes the db to reconnect and retry executing the SQL statement in case of a connection-related exception. This option should only be enabled for known idempotent queries.
Note: the query is assumed to have side effects and the query cache will be cleared. If the query is read-only, consider using #select_all instead.
Note: depending on your database connector, the result returned by this method may be manually memory managed. Consider using #exec_query wrapper instead.
139 140 141 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 139 def execute(sql, name = nil, allow_retry: false) internal_execute(sql, name, allow_retry: allow_retry) end |
#explain(arel, binds = [], options = []) ⇒ Object
:nodoc:
183 184 185 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 183 def explain(arel, binds = [], = []) # :nodoc: raise NotImplementedError end |
#high_precision_current_timestamp ⇒ Object
Returns an Arel SQL literal for the CURRENT_TIMESTAMP for usage with arbitrary precision date/time columns.
Adapters supporting datetime with precision should override this to provide as much precision as is available.
539 540 541 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 539 def HIGH_PRECISION_CURRENT_TIMESTAMP end |
#initialize ⇒ Object
6 7 8 9 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 6 def initialize super reset_transaction end |
#insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [], returning: nil) ⇒ Object Also known as: create
Executes an INSERT query and returns the new record’s ID
id_value
will be returned unless the value is nil
, in which case the database will attempt to calculate the last inserted id and return that value.
If the next id was calculated in advance (as in Oracle), it should be passed in as id_value
. Some adapters support the ‘returning` keyword argument which allows defining the return value of the method: `nil` is the default value and maintains default behavior. If an array of column names is passed - an array of is returned from the method representing values of the specified columns from the inserted row.
198 199 200 201 202 203 204 205 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 198 def insert(arel, name = nil, pk = nil, id_value = nil, sequence_name = nil, binds = [], returning: nil) sql, binds = to_sql_and_binds(arel, binds) value = exec_insert(sql, name, binds, pk, sequence_name, returning: returning) return returning_column_values(value) unless returning.nil? id_value || last_inserted_id(value) end |
#insert_fixture(fixture, table_name) ⇒ Object
Inserts the given fixture into the table. Overridden in adapters that require something beyond a simple insert (e.g. Oracle). Most of adapters should implement insert_fixtures_set
that leverages bulk SQL insert. We keep this method to provide fallback for databases like SQLite that do not support bulk inserts.
485 486 487 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 485 def insert_fixture(fixture, table_name) execute(build_fixture_sql(Array.wrap(fixture), table_name), "Fixture Insert") end |
#insert_fixtures_set(fixture_set, tables_to_delete = []) ⇒ Object
489 490 491 492 493 494 495 496 497 498 499 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 489 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)}" } statements = table_deletes + fixture_inserts transaction(requires_new: true) do disable_referential_integrity do execute_batch(statements, "Fixtures Load") end end end |
#internal_exec_query ⇒ Object
Execute a query and returns an ActiveRecord::Result
549 550 551 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 549 def internal_exec_query(...) # :nodoc: cast_result(internal_execute(...)) end |
#mark_transaction_written_if_write(sql) ⇒ Object
:nodoc:
375 376 377 378 379 380 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 375 def mark_transaction_written_if_write(sql) # :nodoc: transaction = current_transaction if transaction.open? transaction.written ||= write_query?(sql) end end |
#query(sql, name = nil, allow_retry: true, materialize_transactions: true) ⇒ Object
:nodoc:
116 117 118 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 116 def query(sql, name = nil, allow_retry: true, materialize_transactions: true) # :nodoc: internal_exec_query(sql, name, allow_retry:, materialize_transactions:).rows end |
#query_value ⇒ Object
:nodoc:
108 109 110 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 108 def query_value(...) # :nodoc: single_value_from_rows(query(...)) end |
#query_values ⇒ Object
:nodoc:
112 113 114 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 112 def query_values(...) # :nodoc: query(...).map(&:first) end |
#raw_exec_query ⇒ Object
Same as raw_execute but returns an ActiveRecord::Result object.
544 545 546 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 544 def raw_exec_query(...) # :nodoc: cast_result(raw_execute(...)) end |
#reset_isolation_level ⇒ Object
Hook point called after an isolated DB transaction is committed or rolled back. Most adapters don’t need to implement anything because the isolation level is set on a per transaction basis. But some databases like SQLite set it on a per connection level and need to explicitly reset it after commit or rollback.
445 446 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 445 def reset_isolation_level end |
#reset_sequence!(table, column, sequence = nil) ⇒ Object
Set the sequence to the max value of the table’s column.
476 477 478 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 476 def reset_sequence!(table, column, sequence = nil) # Do nothing by default. Implement for PostgreSQL, Oracle, ... end |
#reset_transaction(restore: false) ⇒ Object
:nodoc:
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 386 def reset_transaction(restore: false) # :nodoc: # Store the existing transaction state to the side old_state = @transaction_manager if restore && @transaction_manager&.restorable? @transaction_manager = ConnectionAdapters::TransactionManager.new(self) if block_given? # Reconfigure the connection without any transaction state in the way result = yield # Now the connection's fully established, we can swap back if old_state @transaction_manager = old_state @transaction_manager.restore_transactions end result end end |
#restart_db_transaction ⇒ Object
461 462 463 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 461 def restart_db_transaction exec_restart_db_transaction end |
#rollback_db_transaction ⇒ Object
Rolls back the transaction (and turns on auto-committing). Must be done if the transaction block raises an exception or returns false.
453 454 455 456 457 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 453 def rollback_db_transaction exec_rollback_db_transaction rescue ActiveRecord::ConnectionNotEstablished, ActiveRecord::ConnectionFailed # Connection's gone; that counts as a rollback end |
#rollback_to_savepoint(name = nil) ⇒ Object
467 468 469 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 467 def rollback_to_savepoint(name = nil) exec_rollback_to_savepoint(name) end |
#sanitize_limit(limit) ⇒ Object
Sanitizes the given LIMIT parameter in order to prevent SQL injection.
The limit
may be anything that can evaluate to a string via #to_s. It should look like an integer, or an Arel SQL literal.
Returns Integer and Arel::Nodes::SqlLiteral limits as is.
511 512 513 514 515 516 517 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 511 def sanitize_limit(limit) if limit.is_a?(Integer) || limit.is_a?(Arel::Nodes::SqlLiteral) limit else Integer(limit) end end |
#select_all(arel, name = nil, binds = [], preparable: nil, async: false, allow_retry: false) ⇒ Object
Returns an ActiveRecord::Result instance.
72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 72 def select_all(arel, name = nil, binds = [], preparable: nil, async: false, allow_retry: false) arel = arel_from_relation(arel) sql, binds, preparable, allow_retry = to_sql_and_binds(arel, binds, preparable, allow_retry) select(sql, name, binds, prepare: prepared_statements && preparable, async: async && FutureResult::SelectAll, allow_retry: allow_retry ) rescue ::RangeError ActiveRecord::Result.empty(async: async) end |
#select_one(arel, name = nil, binds = [], async: false) ⇒ Object
Returns a record hash with the column names as keys and column values as values.
87 88 89 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 87 def select_one(arel, name = nil, binds = [], async: false) select_all(arel, name, binds, async: async).then(&:first) end |
#select_rows(arel, name = nil, binds = [], async: false) ⇒ Object
Returns an array of arrays containing the field values. Order is the same as that returned by columns
.
104 105 106 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 104 def select_rows(arel, name = nil, binds = [], async: false) select_all(arel, name, binds, async: async).then(&:rows) end |
#select_value(arel, name = nil, binds = [], async: false) ⇒ Object
Returns a single value from a record
92 93 94 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 92 def select_value(arel, name = nil, binds = [], async: false) select_rows(arel, name, binds, async: async).then { |rows| single_value_from_rows(rows) } end |
#select_values(arel, name = nil, binds = []) ⇒ Object
Returns an array of the values of the first column in a select:
select_values("SELECT id FROM companies LIMIT 3") => [1,2,3]
98 99 100 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 98 def select_values(arel, name = nil, binds = []) select_rows(arel, name, binds).map(&:first) end |
#to_sql(arel_or_sql_string, binds = []) ⇒ Object
Converts an arel AST to SQL
12 13 14 15 |
# 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 |
#transaction(requires_new: nil, isolation: nil, joinable: true, &block) ⇒ Object
Runs the given block in a database transaction, and returns the result of the block.
Transaction callbacks
#transaction yields an ActiveRecord::Transaction object on which it is possible to register callback:
ActiveRecord::Base.transaction do |transaction|
transaction.before_commit { puts "before commit!" }
transaction.after_commit { puts "after commit!" }
transaction.after_rollback { puts "after rollback!" }
end
Nested transactions support
#transaction calls can be nested. By default, this makes all database statements in the nested transaction block become part of the parent transaction. For example, the following behavior may be surprising:
ActiveRecord::Base.transaction do
Post.create(title: 'first')
ActiveRecord::Base.transaction do
Post.create(title: 'second')
raise ActiveRecord::Rollback
end
end
This creates both “first” and “second” posts. Reason is the ActiveRecord::Rollback exception in the nested block does not issue a ROLLBACK. Since these exceptions are captured in transaction blocks, the parent block does not see it and the real transaction is committed.
Most databases don’t support true nested transactions. At the time of writing, the only database that supports true nested transactions that we’re aware of, is MS-SQL.
In order to get around this problem, #transaction will emulate the effect of nested transactions, by using savepoints: dev.mysql.com/doc/refman/en/savepoint.html.
It is safe to call this method if a database transaction is already open, i.e. if #transaction is called within another #transaction block. In case of a nested call, #transaction will behave as follows:
-
The block will be run without doing anything. All database statements that happen within the block are effectively appended to the already open database transaction.
-
However, if
:requires_new
is set, the block will be wrapped in a database savepoint acting as a sub-transaction.
In order to get a ROLLBACK for the nested transaction you may ask for a real sub-transaction by passing requires_new: true
. If anything goes wrong, the database rolls back to the beginning of the sub-transaction without rolling back the parent transaction. If we add it to the previous example:
ActiveRecord::Base.transaction do
Post.create(title: 'first')
ActiveRecord::Base.transaction(requires_new: true) do
Post.create(title: 'second')
raise ActiveRecord::Rollback
end
end
only post with title “first” is created.
See ActiveRecord::Transactions to learn more.
Caveats
MySQL doesn’t support DDL transactions. If you perform a DDL operation, then any created savepoints will be automatically released. For example, if you’ve created a savepoint, then you execute a CREATE TABLE statement, then the savepoint that was created will be automatically released.
This means that, on MySQL, you shouldn’t execute DDL operations inside a #transaction call that you know might create a savepoint. Otherwise, #transaction will raise exceptions when it tries to release the already-automatically-released savepoints:
Model.lease_connection.transaction do # BEGIN
Model.lease_connection.transaction(requires_new: true) do # CREATE SAVEPOINT active_record_1
Model.lease_connection.create_table(...)
# active_record_1 now automatically released
end # RELEASE SAVEPOINT active_record_1 <--- BOOM! database error!
end
Transaction isolation
If your database supports setting the isolation level for a transaction, you can set it like so:
Post.transaction(isolation: :serializable) do
# ...
end
Valid isolation levels are:
-
:read_uncommitted
-
:read_committed
-
:repeatable_read
-
:serializable
You should consult the documentation for your database to understand the semantics of these different levels:
An ActiveRecord::TransactionIsolationError will be raised if:
-
The adapter does not support setting the isolation level
-
You are joining an existing open transaction
-
You are creating a nested (savepoint) transaction
The mysql2, trilogy, and postgresql adapters support setting the transaction isolation level.
:args: (requires_new: nil, isolation: nil, &block)
355 356 357 358 359 360 361 362 363 364 365 366 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 355 def transaction(requires_new: nil, isolation: nil, joinable: true, &block) if !requires_new && current_transaction.joinable? if isolation raise ActiveRecord::TransactionIsolationError, "cannot set isolation when joining a transaction" end yield current_transaction.user_transaction else within_new_transaction(isolation: isolation, joinable: joinable, &block) end rescue ActiveRecord::Rollback # rollbacks are silently swallowed end |
#transaction_isolation_levels ⇒ Object
423 424 425 426 427 428 429 430 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 423 def transaction_isolation_levels { read_uncommitted: "READ UNCOMMITTED", read_committed: "READ COMMITTED", repeatable_read: "REPEATABLE READ", serializable: "SERIALIZABLE" } end |
#transaction_open? ⇒ Boolean
382 383 384 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 382 def transaction_open? current_transaction.open? end |
#truncate(table_name, name = nil) ⇒ Object
Executes the truncate statement.
221 222 223 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 221 def truncate(table_name, name = nil) execute(build_truncate_statement(table_name), name) end |
#truncate_tables(*table_names) ⇒ Object
:nodoc:
225 226 227 228 229 230 231 232 233 234 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 225 def truncate_tables(*table_names) # :nodoc: table_names -= [pool.schema_migration.table_name, pool..table_name] return if table_names.empty? disable_referential_integrity do statements = build_truncate_statements(table_names) execute_batch(statements, "Truncate Tables") end end |
#update(arel, name = nil, binds = []) ⇒ Object
Executes the update statement and returns the number of rows affected.
209 210 211 212 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 209 def update(arel, name = nil, binds = []) sql, binds = to_sql_and_binds(arel, binds) exec_update(sql, name, binds) end |
#with_yaml_fallback(value) ⇒ Object
Fixture value is quoted by Arel, however scalar values are not quotable. In this case we want to convert the column value to YAML.
522 523 524 525 526 527 528 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 522 def with_yaml_fallback(value) # :nodoc: if value.is_a?(Hash) || value.is_a?(Array) YAML.dump(value) else value end end |
#write_query?(sql) ⇒ Boolean
Determines whether the SQL statement is a write query.
121 122 123 |
# File 'activerecord/lib/active_record/connection_adapters/abstract/database_statements.rb', line 121 def write_query?(sql) raise NotImplementedError end |