Result — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::Operation::Update::Result

Inherits:

Result

• Object
• Result
• Mongo::Operation::Update::Result show all

Defined in:

lib/mongo/operation/update/result.rb

Overview

Defines custom behavior of results for an update.

Constant Summarycollapse

MODIFIED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The number of modified docs field in the result.

'nModified'.freeze

UPSERTED =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

The upserted docs field in the result.

'upserted'.freeze

Constants inherited from Result

Result::CURSOR, Result::CURSOR_ID, Result::FIRST_BATCH, Result::N, Result::NAMESPACE, Result::NEXT_BATCH, Result::OK, Result::RESULT

Instance Attribute Summary

Attributes inherited from Result

#connection, #connection_description, #connection_global_id, #context, #replies

Instance Method Summarycollapse

• #bulk_result ⇒ Object
• #matched_count ⇒ Integer
  Get the number of documents matched.
• #modified_count ⇒ Integer
  Get the number of documents modified.
• #upserted_count ⇒ Integer
  Returns the number of documents upserted.
• #upserted_id ⇒ Object
  The identifier of the inserted document if an upsert took place.

Methods inherited from Result

#acknowledged?, #cluster_time, #cursor_id, #documents, #each, #error, #has_cursor_id?, #initialize, #inspect, #labels, #namespace, #ok?, #operation_time, #reply, #returned_count, #snapshot_timestamp, #successful?, #topology_version, #validate!, #write_concern_error?, #written_count

Instance Method Details

#bulk_result ⇒ Object

#matched_count ⇒ Integer

Get the number of documents matched.

#modified_count ⇒ Integer

Get the number of documents modified.

#upserted_count ⇒ Integer

Returns the number of documents upserted.

#upserted_id ⇒ Object

The identifier of the inserted document if an upsert

took place.