Module: ActiveRecord::Locking::Optimistic::ClassMethods
- Defined in:
- lib/active_record/locking/optimistic.rb
Constant Summary collapse
- DEFAULT_LOCKING_COLUMN =
"lock_version"
Instance Attribute Summary collapse
-
#locking_column ⇒ Object
The version column used for optimistic locking.
Instance Method Summary collapse
-
#define_attribute(name, cast_type) ⇒ Object
:nodoc:.
-
#locking_enabled? ⇒ Boolean
Returns true if the
lock_optimistically
flag is set to true (which it is, by default) and the table includes thelocking_column
column (defaults tolock_version
). -
#reset_locking_column ⇒ Object
Reset the column used for optimistic locking back to the
lock_version
default. -
#update_counters(id, counters) ⇒ Object
Make sure the lock version column gets updated when counters are updated.
Instance Attribute Details
#locking_column ⇒ Object
The version column used for optimistic locking. Defaults to lock_version
.
171 172 173 |
# File 'lib/active_record/locking/optimistic.rb', line 171 def locking_column @locking_column end |
Instance Method Details
#define_attribute(name, cast_type) ⇒ Object
:nodoc:
185 186 187 188 189 190 |
# File 'lib/active_record/locking/optimistic.rb', line 185 def define_attribute(name, cast_type, **) # :nodoc: if lock_optimistically && name == locking_column cast_type = LockingType.new(cast_type) end super 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
).
160 161 162 |
# File 'lib/active_record/locking/optimistic.rb', line 160 def locking_enabled? lock_optimistically && columns_hash[locking_column] end |
#reset_locking_column ⇒ Object
Reset the column used for optimistic locking back to the lock_version
default.
174 175 176 |
# File 'lib/active_record/locking/optimistic.rb', line 174 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.
180 181 182 183 |
# File 'lib/active_record/locking/optimistic.rb', line 180 def update_counters(id, counters) counters = counters.merge(locking_column => 1) if locking_enabled? super end |