Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add more information about transactions.

  • Loading branch information...
commit 253259f391dbec534015972566ec74f17582bf2f 1 parent 86a0e98
@FooBarWidget FooBarWidget authored
Showing with 16 additions and 2 deletions.
  1. +16 −2 activerecord/lib/active_record/transactions.rb
View
18 activerecord/lib/active_record/transactions.rb
@@ -25,7 +25,7 @@ def self.included(base)
# have a number of statements that must be executed together or not at all.
# Example:
#
- # transaction do
+ # ActiveRecord::Base.transaction do
# david.withdrawal(100)
# mary.deposit(100)
# end
@@ -40,7 +40,9 @@ def self.included(base)
#
# Though the transaction class method is called on some Active Record class,
# the objects within the transaction block need not all be instances of
- # that class.
+ # that class. This is because transactions are per-database connection, not
+ # per-model.
+ #
# In this example a <tt>Balance</tt> record is transactionally saved even
# though <tt>transaction</tt> is called on the <tt>Account</tt> class:
#
@@ -49,6 +51,14 @@ def self.included(base)
# account.save!
# end
#
+ # Note that the +transaction+ method is also available as a model instance
+ # method. For example, you can also do this:
+ #
+ # balance.transaction do
+ # balance.save!
+ # account.save!
+ # end
+ #
# == Transactions are not distributed across database connections
#
# A transaction acts on a single database connection. If you have
@@ -95,6 +105,7 @@ def transaction(&block)
end
end
+ # See ActiveRecord::Transactions::ClassMethods for detailed documentation.
def transaction(&block)
self.class.transaction(&block)
end
@@ -131,6 +142,9 @@ def rollback_active_record_state!
# Executes +method+ within a transaction and captures its return value as a
# status flag. If the status is true the transaction is committed, otherwise
# a ROLLBACK is issued. In any case the status flag is returned.
+ #
+ # This method is available within the context of an ActiveRecord::Base
+ # instance.
def with_transaction_returning_status(method, *args)
status = nil
transaction do
Please sign in to comment.
Something went wrong with that request. Please try again.