MongoDB C++ Driver mongocxx-3.10.1
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mongocxx::v_noabi::result::update Class Reference

Class representing the result of a MongoDB update operation. More...

#include <update.hpp>

Public Member Functions

const result::bulk_writeresult () const
 Returns the bulk write result for this update operation.
 
std::int32_t matched_count () const
 Gets the number of documents that were matched during this operation.
 
std::int32_t modified_count () const
 Gets the number of documents that were modified during this operation.
 
std::int32_t upserted_count () const
 Gets the number of documents that were upserted during this operation.
 
stdx::optional< bsoncxx::v_noabi::document::elementupserted_id () const
 If a document was upserted during this operation, gets the _id of the upserted document.
 

Detailed Description

Class representing the result of a MongoDB update operation.

Member Function Documentation

◆ matched_count()

std::int32_t mongocxx::v_noabi::result::update::matched_count ( ) const

Gets the number of documents that were matched during this operation.

Returns
The number of documents that were matched.

◆ modified_count()

std::int32_t mongocxx::v_noabi::result::update::modified_count ( ) const

Gets the number of documents that were modified during this operation.

Returns
The number of documents that were modified.

◆ result()

const result::bulk_write & mongocxx::v_noabi::result::update::result ( ) const

Returns the bulk write result for this update operation.

Returns
The raw bulk write result.

◆ upserted_count()

std::int32_t mongocxx::v_noabi::result::update::upserted_count ( ) const

Gets the number of documents that were upserted during this operation.

Returns
The number of documents that were upserted.

◆ upserted_id()

stdx::optional< bsoncxx::v_noabi::document::element > mongocxx::v_noabi::result::update::upserted_id ( ) const

If a document was upserted during this operation, gets the _id of the upserted document.

Returns
The value of the _id field for upserted document.

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