W3cubDocs

module ActiveRecord::Locking::Optimistic::ClassMethods

Constants

DEFAULT_LOCKING_COLUMN

Public Instance Methods

locking_column() Show source

The version column used for optimistic locking. Defaults to lock_version.

# File activerecord/lib/active_record/locking/optimistic.rb, line 156
def locking_column
  reset_locking_column unless defined?(@locking_column)
  @locking_column
end

locking_column=(value) Show source

Set the column to use for optimistic locking. Defaults to lock_version.

# File activerecord/lib/active_record/locking/optimistic.rb, line 150
def locking_column=(value)
  clear_caches_calculated_from_columns
  @locking_column = value.to_s
end

locking_enabled?() Show source

Returns true if the lock_optimistically flag is set to true (which it is, by default) and the table includes the locking_column column (defaults to lock_version).

# File activerecord/lib/active_record/locking/optimistic.rb, line 145
def locking_enabled?
  lock_optimistically && columns_hash[locking_column]
end

reset_locking_column() Show source

Reset the column used for optimistic locking back to the lock_version default.

# File activerecord/lib/active_record/locking/optimistic.rb, line 162
def reset_locking_column
  self.locking_column = DEFAULT_LOCKING_COLUMN
end

update_counters(id, counters) Show source

Make sure the lock version column gets updated when counters are updated.

Calls superclass method

# File activerecord/lib/active_record/locking/optimistic.rb, line 168
def update_counters(id, counters)
  counters = counters.merge(locking_column => 1) if locking_enabled?
  super
end