Files

Class Index [+]

Quicksearch

ActiveRecord::Locking::Optimistic::ClassMethods

Constants

DEFAULT_LOCKING_COLUMN

Public Instance Methods

locking_column() click to toggle source

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

     # File lib/active_record/locking/optimistic.rb, line 143
143:         def locking_column
144:           reset_locking_column unless defined?(@locking_column)
145:           @locking_column
146:         end
locking_column=(value) click to toggle source
     # File lib/active_record/locking/optimistic.rb, line 132
132:         def locking_column=(value)
133:           @original_locking_column = @locking_column if defined?(@locking_column)
134:           @locking_column          = value.to_s
135:         end
locking_enabled?() click to toggle source

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 lib/active_record/locking/optimistic.rb, line 128
128:         def locking_enabled?
129:           lock_optimistically && columns_hash[locking_column]
130:         end
quoted_locking_column() click to toggle source

Quote the column name used for optimistic locking.

     # File lib/active_record/locking/optimistic.rb, line 153
153:         def quoted_locking_column
154:           connection.quote_column_name(locking_column)
155:         end
reset_locking_column() click to toggle source

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

     # File lib/active_record/locking/optimistic.rb, line 158
158:         def reset_locking_column
159:           self.locking_column = DEFAULT_LOCKING_COLUMN
160:         end
set_locking_column(value = nil, &block) click to toggle source

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

     # File lib/active_record/locking/optimistic.rb, line 138
138:         def set_locking_column(value = nil, &block)
139:           deprecated_property_setter :locking_column, value, block
140:         end
update_counters(id, counters) click to toggle source

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

     # File lib/active_record/locking/optimistic.rb, line 164
164:         def update_counters(id, counters)
165:           counters = counters.merge(locking_column => 1) if locking_enabled?
166:           super
167:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.