Module: ActiveRecord::Transactions

Extended by:
ActiveSupport::Concern
Included in:
Base
Defined in:
activerecord/lib/active_record/transactions.rb

Overview

See ActiveRecord::Transactions::ClassMethods for documentation.

Defined Under Namespace

Modules: ClassMethods

Constant Summary collapse

ACTIONS =

:nodoc:

[:create, :destroy, :update]

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, class_methods, extended, included, prepend_features, prepended

Instance Method Details

#before_committed! ⇒ Object

:nodoc:


309
310
311
 
# File 'activerecord/lib/active_record/transactions.rb', line 309

def before_committed! # :nodoc:
  _run_before_commit_callbacks
end

#committed!(should_run_callbacks: true) ⇒ Object

Call the #after_commit callbacks.

Ensure that it is not called if the object was never persisted (failed create), but call it after the commit of a destroyed object.


317
318
319
320
321
322
323
324
325
 
# File 'activerecord/lib/active_record/transactions.rb', line 317

def committed!(should_run_callbacks: true) # :nodoc:
  @_start_transaction_state = nil
  if should_run_callbacks
    @_committed_already_called = true
    _run_commit_callbacks
  end
ensure
  @_committed_already_called = @_trigger_update_callback = @_trigger_destroy_callback = false
end

#destroy ⇒ Object

:nodoc:


293
294
295
 
# File 'activerecord/lib/active_record/transactions.rb', line 293

def destroy # :nodoc:
  with_transaction_returning_status { super }
end

#rolledback!(force_restore_state: false, should_run_callbacks: true) ⇒ Object

Call the #after_rollback callbacks. The force_restore_state argument indicates if the record state should be rolled back to the beginning or just to the last savepoint.


329
330
331
332
333
334
335
336
337
 
# File 'activerecord/lib/active_record/transactions.rb', line 329

def rolledback!(force_restore_state: false, should_run_callbacks: true) # :nodoc:
  if should_run_callbacks
    _run_rollback_callbacks
  end
ensure
  restore_transaction_record_state(force_restore_state)
  clear_transaction_record_state
  @_trigger_update_callback = @_trigger_destroy_callback = false if force_restore_state
end

#save ⇒ Object

:nodoc:


297
298
299
 
# File 'activerecord/lib/active_record/transactions.rb', line 297

def save(**) # :nodoc:
  with_transaction_returning_status { super }
end

#save! ⇒ Object

:nodoc:


301
302
303
 
# File 'activerecord/lib/active_record/transactions.rb', line 301

def save!(**) # :nodoc:
  with_transaction_returning_status { super }
end

#touch ⇒ Object

:nodoc:


305
306
307
 
# File 'activerecord/lib/active_record/transactions.rb', line 305

def touch(*, **) # :nodoc:
  with_transaction_returning_status { super }
end

#transaction(**options, &block) ⇒ Object

See ActiveRecord::Transactions::ClassMethods for detailed documentation.


289
290
291
 
# File 'activerecord/lib/active_record/transactions.rb', line 289

def transaction(**options, &block)
  self.class.transaction(**options, &block)
end

#trigger_transactional_callbacks? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 

360
361
362
363
 
# File 'activerecord/lib/active_record/transactions.rb', line 360

def trigger_transactional_callbacks? # :nodoc:
  (@_new_record_before_last_commit || _trigger_update_callback) && persisted? ||
    _trigger_destroy_callback && destroyed?
end

#with_transaction_returning_status ⇒ Object

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.


345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'activerecord/lib/active_record/transactions.rb', line 345

def with_transaction_returning_status
  status = nil
  connection = self.class.connection
  ensure_finalize = !connection.transaction_open?

  connection.transaction do
    add_to_transaction(ensure_finalize || has_transactional_callbacks?)
    remember_transaction_record_state

    status = yield
    raise ActiveRecord::Rollback unless status
  end
  status
end