mongocxx::options::update Class Reference

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

#include <update.hpp>

Public Member Functions
update &	upsert (bool upsert)
	Sets the upsert option.
const stdx::optional< bool > &	upsert () const
	Gets the current value of the upsert option.
update &	bypass_document_validation (bool bypass_document_validation)
	Sets the bypass_document_validation option.
const stdx::optional< bool > &	bypass_document_validation () const
	Gets the current value of the bypass_document_validation option.
update &	write_concern (class write_concern wc)
	Sets the write_concern for this operation.
const stdx::optional< class write_concern > &	write_concern () const
	The current write_concern for this operation.

Detailed Description

Class representing the optional arguments to a MongoDB update operation.

Member Function Documentation

bypass_document_validation() [1/2]

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.

bypass_document_validation() [2/2]

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_validation

Whether or not to bypass document validation

upsert() [1/2]

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.

upsert() [2/2]

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

upsert

If 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.

write_concern() [1/2]

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/

write_concern() [2/2]

update & mongocxx::options::update::write_concern

(

class write_concern

wc

)

Sets the write_concern for this operation.

Parameters

wc	The new write_concern

See also

http://docs.mongodb.org/manual/core/write-concern/

---

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

• src/mongocxx/options/update.hpp