MongoDB C++ Driver  mongocxx-3.0.2
Public Member Functions | List of all members
mongocxx::options::update Class Reference

Class representing the optional arguments to a MongoDB update operation. More...

#include <update.hpp>

Public Member Functions

updateupsert (bool upsert)
 Sets the upsert option. More...
 
const stdx::optional< bool > & upsert () const
 Gets the current value of the upsert option. More...
 
updatebypass_document_validation (bool bypass_document_validation)
 Sets the bypass_document_validation option. More...
 
const stdx::optional< bool > & bypass_document_validation () const
 Gets the current value of the bypass_document_validation option. More...
 
updatewrite_concern (class write_concern wc)
 Sets the write_concern for this operation. More...
 
const stdx::optional< class write_concern > & write_concern () const
 The current write_concern for this operation. More...
 

Detailed Description

Class representing the optional arguments to a MongoDB update operation.

Member Function Documentation

update& mongocxx::options::update::bypass_document_validation ( bool  bypass_document_validation)

Sets the bypass_document_validation option.

If true, allows the write to opt-out of document level validation.

Note
On servers >= 3.2, the server applies validation by default. On servers < 3.2, this option is ignored.
Parameters
bypass_document_validationWhether or not to bypass document validation
const stdx::optional<bool>& mongocxx::options::update::bypass_document_validation ( ) const

Gets the current value of the bypass_document_validation option.

Returns
The optional value of the bypass_document_validation option.
update& mongocxx::options::update::upsert ( bool  upsert)

Sets the upsert option.

By default, if no document matches the filter, the update operation does nothing. However, by specifying upsert as true, this operation either updates matching documents or inserts a new document using the update specification if no matching document exists.

Parameters
upsertIf set to true, creates a new document when no document matches the query criteria. The server-side default is false, which does not insert a new document if a match is not found.
const stdx::optional<bool>& mongocxx::options::update::upsert ( ) const

Gets the current value of the upsert option.

Returns
The optional value of the upsert option.
update& mongocxx::options::update::write_concern ( class write_concern  wc)

Sets the write_concern for this operation.

Parameters
wcThe new write_concern
See also
http://docs.mongodb.org/manual/core/write-concern/
const stdx::optional<class write_concern>& mongocxx::options::update::write_concern ( ) const

The current write_concern for this operation.

Returns
The current write_concern
See also
http://docs.mongodb.org/manual/core/write-concern/

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