Module ActiveRecord::Locking::Optimistic::ClassMethods
In: vendor/rails/activerecord/lib/active_record/locking/optimistic.rb

Methods

Constants

DEFAULT_LOCKING_COLUMN = 'lock_version'

Public Class methods

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 101
101:         def self.extended(base)
102:           class <<base
103:             alias_method_chain :update_counters, :lock
104:           end
105:         end

Public Instance methods

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

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 122
122:         def locking_column
123:           reset_locking_column
124:         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).

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 111
111:         def locking_enabled?
112:           lock_optimistically && columns_hash[locking_column]
113:         end

Quote the column name used for optimistic locking.

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 127
127:         def quoted_locking_column
128:           connection.quote_column_name(locking_column)
129:         end

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

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 132
132:         def reset_locking_column
133:           set_locking_column DEFAULT_LOCKING_COLUMN
134:         end

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

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 116
116:         def set_locking_column(value = nil, &block)
117:           define_attr_method :locking_column, value, &block
118:           value
119:         end

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

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 138
138:         def update_counters_with_lock(id, counters)
139:           counters = counters.merge(locking_column => 1) if locking_enabled?
140:           update_counters_without_lock(id, counters)
141:         end

[Validate]