Methods
Constants
DEFAULT_LOCKING_COLUMN = 'lock_version'
Public Class methods
extended(base)

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 138
138:         def self.extended(base)
139:           class <<base
140:             alias_method_chain :update_counters, :lock
141:           end
142:         end
Public Instance methods
locking_column()

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

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 159
159:         def locking_column
160:           reset_locking_column
161:         end
locking_enabled?()

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

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 148
148:         def locking_enabled?
149:           lock_optimistically && columns_hash[locking_column]
150:         end
quoted_locking_column()

Quote the column name used for optimistic locking.

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 164
164:         def quoted_locking_column
165:           connection.quote_column_name(locking_column)
166:         end
reset_locking_column()

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

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 169
169:         def reset_locking_column
170:           set_locking_column DEFAULT_LOCKING_COLUMN
171:         end
set_locking_column(value = nil, &block)

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

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 153
153:         def set_locking_column(value = nil, &block)
154:           define_attr_method :locking_column, value, &block
155:           value
156:         end
update_counters_with_lock(id, counters)

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

[ show source ]

     # File activerecord/lib/active_record/locking/optimistic.rb, line 175
175:         def update_counters_with_lock(id, counters)
176:           counters = counters.merge(locking_column => 1) if locking_enabled?
177:           update_counters_without_lock(id, counters)
178:         end