Files

Class/Module Index [+]

Quicksearch

ActiveRecord::Locking::Optimistic::ClassMethods

Public Instance Methods

locking_column() click to toggle source

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

# File lib/active_record/locking/optimistic.rb, line 143
def locking_column
  reset_locking_column unless defined?(@locking_column)
  @locking_column
end
locking_column=(value) click to toggle source
# File lib/active_record/locking/optimistic.rb, line 132
def locking_column=(value)
  @original_locking_column = @locking_column if defined?(@locking_column)
  @locking_column          = value.to_s
end
locking_enabled?() click to toggle 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 lib/active_record/locking/optimistic.rb, line 128
def locking_enabled?
  lock_optimistically && columns_hash[locking_column]
end
quoted_locking_column() click to toggle source

Quote the column name used for optimistic locking.

# File lib/active_record/locking/optimistic.rb, line 153
def quoted_locking_column
  connection.quote_column_name(locking_column)
end
reset_locking_column() click to toggle source

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

# File lib/active_record/locking/optimistic.rb, line 158
def reset_locking_column
  self.locking_column = DEFAULT_LOCKING_COLUMN
end
set_locking_column(value = nil, &block) click to toggle source

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

# File lib/active_record/locking/optimistic.rb, line 138
def set_locking_column(value = nil, &block)
  deprecated_property_setter :locking_column, value, block
end
update_counters(id, counters) click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.