Module: ActiveRecord::Locking::Optimistic

Defined in:
lib/active_record/locking/optimistic.rb

Overview

What is Optimistic Locking

Optimistic locking allows multiple users to access the same record for edits, and assumes a minimum of conflicts with the data. It does this by checking whether another process has made changes to a record since it was opened, an ActiveRecord::StaleObjectError is thrown if that has occurred and the update is ignored.

Check out ActiveRecord::Locking::Pessimistic for an alternative.

Usage

Active Records support optimistic locking if the field lock_version is present. Each update to the record increments the lock_version column and the locking facilities ensure that records instantiated twice will let the last one saved raise a StaleObjectError if the first was also updated. Example:

p1 = Person.find(1)
p2 = Person.find(1)

p1.first_name = "Michael"
p1.save

p2.first_name = "should fail"
p2.save # Raises a ActiveRecord::StaleObjectError

Optimistic locking will also check for stale data when objects are destroyed. Example:

p1 = Person.find(1)
p2 = Person.find(1)

p1.first_name = "Michael"
p1.save

p2.destroy # Raises a ActiveRecord::StaleObjectError

You’re then responsible for dealing with the conflict by rescuing the exception and either rolling back, merging, or otherwise apply the business logic needed to resolve the conflict.

You must ensure that your database schema defaults the lock_version column to 0.

This behavior can be turned off by setting ActiveRecord::Base.lock_optimistically = false. To override the name of the lock_version column, invoke the set_locking_column method. This method uses the same syntax as set_table_name

Defined Under Namespace

Modules: ClassMethods

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object

:nodoc:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/active_record/locking/optimistic.rb', line 45

def self.included(base) #:nodoc:
  base.extend ClassMethods

  base.cattr_accessor :lock_optimistically, :instance_writer => false
  base.lock_optimistically = true

  base.alias_method_chain :update, :lock
  base.alias_method_chain :destroy, :lock
  base.alias_method_chain :attributes_from_column_definition, :lock

  class << base
    alias_method :locking_column=, :set_locking_column
  end
end

Instance Method Details

#locking_enabled? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/active_record/locking/optimistic.rb', line 60

def locking_enabled? #:nodoc:
  self.class.locking_enabled?
end