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 105
105:         def self.extended(base)
106:           class <<base
107:             alias_method_chain :update_counters, :lock
108:           end
109:         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 126
126:         def locking_column
127:           reset_locking_column
128:         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 115
115:         def locking_enabled?
116:           lock_optimistically && columns_hash[locking_column]
117:         end

Quote the column name used for optimistic locking.

[Source]

     # File vendor/rails/activerecord/lib/active_record/locking/optimistic.rb, line 131
131:         def quoted_locking_column
132:           connection.quote_column_name(locking_column)
133:         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 136
136:         def reset_locking_column
137:           set_locking_column DEFAULT_LOCKING_COLUMN
138:         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 120
120:         def set_locking_column(value = nil, &block)
121:           define_attr_method :locking_column, value, &block
122:           value
123:         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 142
142:         def update_counters_with_lock(id, counters)
143:           counters = counters.merge(locking_column => 1) if locking_enabled?
144:           update_counters_without_lock(id, counters)
145:         end

[Validate]