Module | ActiveRecord::Locking::Optimistic::ClassMethods |
In: |
vendor/rails/activerecord/lib/active_record/locking/optimistic.rb
|
DEFAULT_LOCKING_COLUMN | = | 'lock_version' |
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 104 104: def self.extended(base) 105: class <<base 106: alias_method_chain :update_counters, :lock 107: end 108: end
The version column used for optimistic locking. Defaults to lock_version.
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 125 125: def locking_column 126: reset_locking_column 127: end
Is optimistic locking enabled for this table? 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 vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 114 114: def locking_enabled? 115: lock_optimistically && columns_hash[locking_column] 116: end
Quote the column name used for optimistic locking.
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 130 130: def quoted_locking_column 131: connection.quote_column_name(locking_column) 132: end
Reset the column used for optimistic locking back to the lock_version default.
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 135 135: def reset_locking_column 136: set_locking_column DEFAULT_LOCKING_COLUMN 137: end
Set the column to use for optimistic locking. Defaults to lock_version.
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 119 119: def set_locking_column(value = nil, &block) 120: define_attr_method :locking_column, value, &block 121: value 122: end
Make sure the lock version column gets updated when counters are updated.
# File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 141 141: def update_counters_with_lock(id, counters) 142: counters = counters.merge(locking_column => 1) if locking_enabled? 143: update_counters_without_lock(id, counters) 144: end