Module: ActiveRecord::Locking::Optimistic::ClassMethods

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

Constant Summary collapse

DEFAULT_LOCKING_COLUMN =
"lock_version"

Instance Method Summary collapse

Instance Method Details

#define_attribute(name, cast_type) ⇒ Object

:nodoc:


179
180
181
182
183
184
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 179

def define_attribute(name, cast_type, **) # :nodoc:
  if lock_optimistically && name == locking_column
    cast_type = LockingType.new(cast_type)
  end
  super
end

#locking_columnObject

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


162
163
164
165
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 162

def locking_column
  @locking_column = DEFAULT_LOCKING_COLUMN unless defined?(@locking_column)
  @locking_column
end

#locking_column=(value) ⇒ Object

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


156
157
158
159
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 156

def locking_column=(value)
  reload_schema_from_cache
  @locking_column = value.to_s
end

#locking_enabled?Boolean

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).

Returns:

  • (Boolean)

151
152
153
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 151

def locking_enabled?
  lock_optimistically && columns_hash[locking_column]
end

#reset_locking_columnObject

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


168
169
170
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 168

def reset_locking_column
  self.locking_column = DEFAULT_LOCKING_COLUMN
end

#update_counters(id, counters) ⇒ Object

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


174
175
176
177
# File 'activerecord/lib/active_record/locking/optimistic.rb', line 174

def update_counters(id, counters)
  counters = counters.merge(locking_column => 1) if locking_enabled?
  super
end