Class Mongo::BulkWrite::Result
In: lib/mongo/bulk_write/result.rb
Parent: Object

Wraps a series of bulk write operations in a result object.

@since 2.0.6

Methods

deleted_count   inserted_count   inserted_ids   matched_count   modified_count   new   upserted_count   upserted_ids   validate!  

Constants

REMOVED_COUNT = 'n_removed'.freeze   Constant for number removed.

@since 2.1.0

INSERTED_COUNT = 'n_inserted'.freeze   Constant for number inserted.

@since 2.1.0

INSERTED_IDS = 'inserted_ids'.freeze   Constant for inserted ids.

@since 2.1.0

MATCHED_COUNT = 'n_matched'.freeze   Constant for number matched.

@since 2.1.0

MODIFIED_COUNT = 'n_modified'.freeze   Constant for number modified.

@since 2.1.0

UPSERTED = 'upserted'.freeze   Constant for upserted.

@since 2.1.0

UPSERTED_COUNT = 'n_upserted'.freeze   Constant for number upserted.

@since 2.1.0

UPSERTED_IDS = 'upserted_ids'.freeze   Constant for upserted ids.

@since 2.1.0

FIELDS = [ INSERTED_COUNT, REMOVED_COUNT, MODIFIED_COUNT, UPSERTED_COUNT, MATCHED_COUNT, Operation::Result::N   The fields contained in the result document returned from executing the operations.

@since 2.1.0.

Public Class methods

new(results)

Create the new result object from the results document.

@example Create the new result. 

  Result.new({ 'n_inserted' => 10 })

@param [ BSON::Document, Hash ] results The results document.

@since 2.1.0

Public Instance methods

deleted_count()

Returns the number of documents deleted.

@example Get the number of deleted documents. 

  result.deleted_count

@return [ Integer ] The number deleted.

@since 2.1.0

inserted_count()

Returns the number of documents inserted.

@example Get the number of inserted documents. 

  result.inserted_count

@return [ Integer ] The number inserted.

@since 2.1.0

inserted_ids()

Get the inserted document ids, if the operation has inserts.

@example Get the inserted ids. 

  result.inserted_ids

@return [ Array<BSON::ObjectId> ] The inserted ids.

@since 2.1.0

matched_count()

Returns the number of documents matched.

@example Get the number of matched documents. 

  result.matched_count

@return [ Integer ] The number matched.

@since 2.1.0

modified_count()

Returns the number of documents modified.

@example Get the number of modified documents. 

  result.modified_count

@return [ Integer ] The number modified.

@since 2.1.0

upserted_count()

Returns the number of documents upserted.

@example Get the number of upserted documents. 

  result.upserted_count

@return [ Integer ] The number upserted.

@since 2.1.0

upserted_ids()

Get the upserted document ids, if the operation has inserts.

@example Get the upserted ids. 

  result.upserted_ids

@return [ Array<BSON::ObjectId> ] The upserted ids.

@since 2.1.0

validate!()

Validates the bulk write result.

@example Validate the result. 

  result.validate!

@raise [ Error::BulkWriteError ] If the result contains errors.

@return [ Result ] The result.

@since 2.1.0

[Validate]