CatapultServer  v0.5.0.1 (Elephant)
catapult::mongo::BulkWriteResult Struct Reference

Result of a bulk write operation to the database. More...

Public Member Functions

 BulkWriteResult ()
 Creates a default bulk write result. More...
 
 BulkWriteResult (const mongocxx::result::bulk_write &result)
 Creates a bulk result from a mongo result. More...
 

Static Public Member Functions

static BulkWriteResult Aggregate (const std::vector< BulkWriteResult > &results)
 Aggregates all bulk write results in results into a single result. More...
 

Public Attributes

int32_t NumInserted
 Number of documents that were inserted. More...
 
int32_t NumMatched
 Number of documents that matched existing documents. More...
 
int32_t NumModified
 Number of existing documents that were modified. More...
 
int32_t NumDeleted
 Number of existing documents that were deleted. More...
 
int32_t NumUpserted
 Number of documents that were inserted because no document matched. More...
 

Detailed Description

Result of a bulk write operation to the database.

Constructor & Destructor Documentation

◆ BulkWriteResult() [1/2]

catapult::mongo::BulkWriteResult::BulkWriteResult ( )
inline

Creates a default bulk write result.

◆ BulkWriteResult() [2/2]

catapult::mongo::BulkWriteResult::BulkWriteResult ( const mongocxx::result::bulk_write &  result)
inlineexplicit

Creates a bulk result from a mongo result.

Member Function Documentation

◆ Aggregate()

static BulkWriteResult catapult::mongo::BulkWriteResult::Aggregate ( const std::vector< BulkWriteResult > &  results)
inlinestatic

Aggregates all bulk write results in results into a single result.

Here is the caller graph for this function:

Member Data Documentation

◆ NumDeleted

int32_t catapult::mongo::BulkWriteResult::NumDeleted

Number of existing documents that were deleted.

◆ NumInserted

int32_t catapult::mongo::BulkWriteResult::NumInserted

Number of documents that were inserted.

◆ NumMatched

int32_t catapult::mongo::BulkWriteResult::NumMatched

Number of documents that matched existing documents.

◆ NumModified

int32_t catapult::mongo::BulkWriteResult::NumModified

Number of existing documents that were modified.

◆ NumUpserted

int32_t catapult::mongo::BulkWriteResult::NumUpserted

Number of documents that were inserted because no document matched.


The documentation for this struct was generated from the following file: