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

Instance Method Details

#add_to_transactionObject

Add the record to the current transaction so that the #after_rollback and #after_commit callbacks can be called.


374
375
376
377
378
379
380
381
382
# File 'activerecord/lib/active_record/transactions.rb', line 374

def add_to_transaction
  if has_transactional_callbacks?
    self.class.connection.add_transaction_record(self)
  else
    sync_with_transaction_state
    set_transaction_state(self.class.connection.transaction_state)
  end
  remember_transaction_record_state
end

#before_committed!Object

:nodoc:


342
343
344
345
# File 'activerecord/lib/active_record/transactions.rb', line 342

def before_committed! # :nodoc:
  _run_before_commit_without_transaction_enrollment_callbacks
  _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.


351
352
353
354
355
356
357
358
# File 'activerecord/lib/active_record/transactions.rb', line 351

def committed!(should_run_callbacks: true) #:nodoc:
  if should_run_callbacks && destroyed? || persisted?
    _run_commit_without_transaction_enrollment_callbacks
    _run_commit_callbacks
  end
ensure
  force_clear_transaction_record_state
end

#destroyObject

:nodoc:


313
314
315
# File 'activerecord/lib/active_record/transactions.rb', line 313

def destroy #:nodoc:
  with_transaction_returning_status { super }
end

#rollback_active_record_state!Object

Reset id and @new_record if the transaction rolls back.


332
333
334
335
336
337
338
339
340
# File 'activerecord/lib/active_record/transactions.rb', line 332

def rollback_active_record_state!
  remember_transaction_record_state
  yield
rescue Exception
  restore_transaction_record_state
  raise
ensure
  clear_transaction_record_state
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.


362
363
364
365
366
367
368
369
370
# File 'activerecord/lib/active_record/transactions.rb', line 362

def rolledback!(force_restore_state: false, should_run_callbacks: true) #:nodoc:
  if should_run_callbacks
    _run_rollback_callbacks
    _run_rollback_without_transaction_enrollment_callbacks
  end
ensure
  restore_transaction_record_state(force_restore_state)
  clear_transaction_record_state
end

#saveObject

:nodoc:


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

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

#save!Object

:nodoc:


323
324
325
# File 'activerecord/lib/active_record/transactions.rb', line 323

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

#touchObject

:nodoc:


327
328
329
# File 'activerecord/lib/active_record/transactions.rb', line 327

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

#transaction(options = {}, &block) ⇒ Object

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


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

def transaction(options = {}, &block)
  self.class.transaction(options, &block)
end

#with_transaction_returning_statusObject

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.


390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
# File 'activerecord/lib/active_record/transactions.rb', line 390

def with_transaction_returning_status
  status = nil
  self.class.transaction do
    add_to_transaction
    begin
      status = yield
    rescue ActiveRecord::Rollback
      clear_transaction_record_state
      status = nil
    end

    raise ActiveRecord::Rollback unless status
  end
  status
ensure
  if @transaction_state && @transaction_state.committed?
    clear_transaction_record_state
  end
end