Module: ActiveRecord::Locking::Optimistic::ClassMethods
- Defined in:
- lib/active_record/locking/optimistic.rb
Constant Summary collapse
- DEFAULT_LOCKING_COLUMN =
'lock_version'
Instance Method Summary collapse
-
#initialize_attributes(attributes, options = {}) ⇒ Object
If the locking column has no default value set, start the lock version at zero.
-
#locking_column ⇒ Object
The version column used for optimistic locking.
- #locking_column=(value) ⇒ Object
-
#locking_enabled? ⇒ Boolean
Returns true if the
lock_optimistically
flag is set to true (which it is, by default) and the table includes thelocking_column
column (defaults tolock_version
). -
#original_locking_column ⇒ Object
:nodoc:.
-
#quoted_locking_column ⇒ Object
Quote the column name used for optimistic locking.
-
#reset_locking_column ⇒ Object
Reset the column used for optimistic locking back to the
lock_version
default. -
#set_locking_column(value = nil, &block) ⇒ Object
Set the column to use for optimistic locking.
-
#update_counters(id, counters) ⇒ Object
Make sure the lock version column gets updated when counters are updated.
Instance Method Details
#initialize_attributes(attributes, options = {}) ⇒ Object
If the locking column has no default value set, start the lock version at zero. Note we can’t use locking_enabled?
at this point as @attributes
may not have been initialized yet.
175 176 177 178 179 180 181 |
# File 'lib/active_record/locking/optimistic.rb', line 175 def initialize_attributes(attributes, = {}) #:nodoc: if attributes.key?(locking_column) && lock_optimistically attributes[locking_column] ||= 0 end attributes end |
#locking_column ⇒ Object
The version column used for optimistic locking. Defaults to lock_version
.
145 146 147 148 |
# File 'lib/active_record/locking/optimistic.rb', line 145 def locking_column reset_locking_column unless defined?(@locking_column) @locking_column end |
#locking_column=(value) ⇒ Object
134 135 136 137 |
# File 'lib/active_record/locking/optimistic.rb', line 134 def locking_column=(value) @original_locking_column = @locking_column if defined?(@locking_column) @locking_column = value.to_s end |
#locking_enabled? ⇒ Boolean
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
).
130 131 132 |
# File 'lib/active_record/locking/optimistic.rb', line 130 def locking_enabled? lock_optimistically && columns_hash[locking_column] end |
#original_locking_column ⇒ Object
:nodoc:
150 151 152 |
# File 'lib/active_record/locking/optimistic.rb', line 150 def original_locking_column #:nodoc: deprecated_original_property_getter :locking_column end |
#quoted_locking_column ⇒ Object
Quote the column name used for optimistic locking.
155 156 157 |
# File 'lib/active_record/locking/optimistic.rb', line 155 def quoted_locking_column connection.quote_column_name(locking_column) end |
#reset_locking_column ⇒ Object
Reset the column used for optimistic locking back to the lock_version
default.
160 161 162 |
# File 'lib/active_record/locking/optimistic.rb', line 160 def reset_locking_column self.locking_column = DEFAULT_LOCKING_COLUMN end |
#set_locking_column(value = nil, &block) ⇒ Object
Set the column to use for optimistic locking. Defaults to lock_version
.
140 141 142 |
# File 'lib/active_record/locking/optimistic.rb', line 140 def set_locking_column(value = nil, &block) deprecated_property_setter :locking_column, value, block end |
#update_counters(id, counters) ⇒ Object
Make sure the lock version column gets updated when counters are updated.
166 167 168 169 |
# File 'lib/active_record/locking/optimistic.rb', line 166 def update_counters(id, counters) counters = counters.merge(locking_column => 1) if locking_enabled? super end |