Module: Mongoid::Persistable::Unsettable

Extended by:
ActiveSupport::Concern
Included in:
Mongoid::Persistable
Defined in:
lib/mongoid/persistable/unsettable.rb

Overview

Defines behavior for $unset operations.

Instance Method Summary collapse

Instance Method Details

#unset(*fields) ⇒ Document

Perform an $unset operation on the provided fields and in the values in the document in memory.

Examples:

Unset the values.

document.unset(:first_name, :last_name, :middle)

Parameters:

  • *fields ([ String | Symbol | Array<String | Symbol>]...)

    The names of the field(s) to unset.

Returns:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/mongoid/persistable/unsettable.rb', line 21

def unset(*fields)
  prepare_atomic_operation do |ops|
    fields.flatten.each do |field|
      normalized = database_field_name(field)
      if executing_atomically?
        process_attribute normalized, nil
      else
        attributes.delete(normalized)
      end
      ops[atomic_attribute_name(normalized)] = true
    end
    { "$unset" => ops }
  end
end