Module: Mongoid::Persistable

Extended by:
ActiveSupport::Concern
Includes:
Creatable, Deletable, Destroyable, Incrementable, Logical, Poppable, Pullable, Pushable, Renamable, Savable, Settable, Unsettable, Updatable, Upsertable, Positional
Included in:
Composable
Defined in:
build/mongoid-master/lib/mongoid/persistable.rb,
build/mongoid-master/lib/mongoid/persistable/logical.rb,
build/mongoid-master/lib/mongoid/persistable/savable.rb,
build/mongoid-master/lib/mongoid/persistable/poppable.rb,
build/mongoid-master/lib/mongoid/persistable/pullable.rb,
build/mongoid-master/lib/mongoid/persistable/pushable.rb,
build/mongoid-master/lib/mongoid/persistable/settable.rb,
build/mongoid-master/lib/mongoid/persistable/creatable.rb,
build/mongoid-master/lib/mongoid/persistable/deletable.rb,
build/mongoid-master/lib/mongoid/persistable/renamable.rb,
build/mongoid-master/lib/mongoid/persistable/updatable.rb,
build/mongoid-master/lib/mongoid/persistable/unsettable.rb,
build/mongoid-master/lib/mongoid/persistable/upsertable.rb,
build/mongoid-master/lib/mongoid/persistable/destroyable.rb,
build/mongoid-master/lib/mongoid/persistable/incrementable.rb

Overview

Contains general behavior for persistence operations.

Since:

  • 2.0.0

Defined Under Namespace

Modules: Creatable, Deletable, Destroyable, Incrementable, Logical, Poppable, Pullable, Pushable, Renamable, Savable, Settable, Unsettable, Updatable, Upsertable

Constant Summary collapse

LIST_OPERATIONS =

The atomic operations that deal with arrays or sets in the db.

Since:

  • 4.0.0

[ "$addToSet", "$push", "$pull", "$pullAll" ].freeze

Instance Method Summary collapse

Methods included from Unsettable

#unset

Methods included from Upsertable

#upsert

Methods included from Updatable

#update, #update!, #update_attribute

Methods included from Settable

#set

Methods included from Savable

#save, #save!

Methods included from Renamable

#rename

Methods included from Pushable

#add_to_set, #push

Methods included from Pullable

#pull, #pull_all

Methods included from Positional

#positionally

Methods included from Poppable

#pop

Methods included from Logical

#bit

Methods included from Incrementable

#inc

Methods included from Destroyable

#destroy, #destroy!

Methods included from Deletable

#delete

Methods included from Creatable

#insert

Instance Method Details

#atomically(join_context: nil) ⇒ true, false

Execute operations atomically (in a single database call) for everything that would happen inside the block. This method supports nesting further calls to atomically, which will behave according to the options described below.

An option join_context can be given which, when true, will merge the operations declared by the given block with the atomically block wrapping the current invocation for the same document, if one exists. If this block or any other block sharing the same context raises before persisting, then all the operations of that context will not be persisted, and will also be reset in memory.

When join_context is false, the given block of operations will be persisted independently of other contexts. Failures in other contexts will not affect this one, so long as this block was able to run and persist changes.

The default value of join_context is set by the global configuration option join_contexts, whose own default is false.

Examples:

Execute the operations atomically.

document.atomically do
  document.set(name: "Tool").inc(likes: 10)
end

Execute some inner operations atomically, but independently from the outer operations.


document.atomically do
  document.inc likes: 10
  document.atomically join_context: false do
    # The following is persisted to the database independently.
    document.unset :origin
  end
  document.atomically join_context: true do
    # The following is persisted along with the other outer operations.
    document.inc member_count: 3
  end
  document.set name: "Tool"
end

Parameters:

  • join_context (true, false) (defaults to: nil)

    Join the context (i.e. merge declared atomic operations) of the atomically block wrapping this one for the same document, if one exists.

Returns:

  • (true, false)

    If the operation succeeded.

Since:

  • 4.0.0



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
# File 'build/mongoid-master/lib/mongoid/persistable.rb', line 94

def atomically(join_context: nil)
  join_context = Mongoid.join_contexts if join_context.nil?
  call_depth = @atomic_depth ||= 0
  has_own_context = call_depth.zero? || !join_context
  @atomic_updates_to_execute_stack ||= []
  _mongoid_push_atomic_context if has_own_context

  if block_given?
    @atomic_depth += 1
    yield(self)
    @atomic_depth -= 1
  end

  if has_own_context
    persist_atomic_operations @atomic_context
    _mongoid_remove_atomic_context_changes
  end

  true
rescue Exception => e
  _mongoid_reset_atomic_context_changes! if has_own_context
  raise e
ensure
  _mongoid_pop_atomic_context if has_own_context

  if call_depth.zero?
    @atomic_depth = nil
    @atomic_updates_to_execute_stack = nil
  end
end

#fail_due_to_callback!(method) ⇒ Object

Raise an error if a callback failed.

Examples:

Raise the callback error.

Person.fail_due_to_callback!(person, :create!)

Parameters:

  • method (Symbol)

    The method being called.

Raises:

Since:

  • 4.0.0



147
148
149
# File 'build/mongoid-master/lib/mongoid/persistable.rb', line 147

def fail_due_to_callback!(method)
  raise Errors::Callback.new(self.class, method)
end

#fail_due_to_validation!Object

Raise an error if validation failed.

Examples:

Raise the validation error.

Person.fail_due_to_validation!(person)

Raises:

Since:

  • 4.0.0



133
134
135
# File 'build/mongoid-master/lib/mongoid/persistable.rb', line 133

def fail_due_to_validation!
  raise Errors::Validations.new(self)
end