Module: Mongoid::Locker::ClassMethods

Defined in:
lib/mongoid/locker.rb

Instance Method Summary collapse

Instance Method Details

#locked ⇒ Mongoid::Criteria

A scope to retrieve all locked documents in the collection.

Examples:

Account.count
#=> 1717
Account.locked.count
#=> 17

Returns:

  • (Mongoid::Criteria) 


134
135
136
137
138
139
140
141
 
# File 'lib/mongoid/locker.rb', line 134

def locked
  where(
    '$and': [
      { locking_name_field => { '$exists': true, '$ne': nil } },
      { locked_at_field => { '$gte': Time.now.utc - (lock_timeout * 1000) } }
    ]
  )
end

#locker(**params) ⇒ Object

Sets configuration for this class.

Examples:

locker locking_name_field: :locker_locking_name,
       locked_at_field: :locker_locked_at,
       lock_timeout: 3,
       locker_write_concern: { w: 1 },
       maximum_backoff: 30.0,
       backoff_algorithm: :locked_at_backoff,
       locking_name_generator: :custom_locking_name

Parameters:

  • locking_name_field (Symbol)
  • locked_at_field (Symbol)
  • maximum_backoff (Float, Integer)
  • lock_timeout (Float, Integer)
  • locker_write_concern (Hash)
  • backoff_algorithm (Symbol)
  • locking_name_generator (Symbol)

Raises:



203
204
205
206
207
208
209
210
 
# File 'lib/mongoid/locker.rb', line 203

def locker(**params)
  invalid_parameters = params.keys - Mongoid::Locker.singleton_class.const_get('MODULE_METHODS')
  raise Mongoid::Locker::Errors::InvalidParameter.new(self.class, invalid_parameters.first) unless invalid_parameters.empty?

  params.each_pair do |key, value|
    send("#{key}=", value)
  end
end

#unlock_all ⇒ Integer

Unlock all locked documents in the collection. Sets locking_name_field and locked_at_field fields to nil. Returns number of unlocked documents.

Examples:

Account.unlock_all
#=> 17
Account.locked.unlock_all
#=> 0

Returns:

  • (Integer) 


181
182
183
 
# File 'lib/mongoid/locker.rb', line 181

def unlock_all
  update_all('$set': { locking_name_field => nil, locked_at_field => nil }).modified_count
end

#unlocked ⇒ Mongoid::Criteria

A scope to retrieve all unlocked documents in the collection.

Examples:

Account.count
#=> 1717
Account.unlocked.count
#=> 1700

Returns:

  • (Mongoid::Criteria) 


152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/mongoid/locker.rb', line 152

def unlocked
  where(
    '$or': [
      {
        '$or': [
          { locking_name_field => { '$exists': false } },
          { locked_at_field => { '$exists': false } }
        ]
      },
      {
        '$or': [
          { locking_name_field => { '$eq': nil } },
          { locked_at_field => { '$eq': nil } }
        ]
      },
      { locked_at_field => { '$lt': Time.now.utc - (lock_timeout * 1000) } }
    ]
  )
end