mongocxx::v1::update_one_options Class Reference

#include <mongocxx/v1/update_one_options.hpp>

Description

Options for an "updateOne" operation.

Supported fields include:

• array_filters ("arrayFilters")
• bypass_document_validation ("bypassDocumentValidation")
• collation
• comment
• hint
• let
• sort
• upsert
• write_concern ("writeConcern")

See also

• Update Methods (MongoDB Manual)

Attention

This feature is experimental! It is not ready for use!

Public Member Functions
	update_one_options ()
	Default initialization.
	update_one_options (update_one_options &&other) noexcept
	Move constructor.
	update_one_options (update_one_options const &other)
	Copy construction.
	~update_one_options ()
	Destroy this object.
bsoncxx::v1::stdx::optional< bsoncxx::v1::array::view >	array_filters () const
	Return the current "arrayFilters" field.
update_one_options &	array_filters (bsoncxx::v1::array::value array_filters)
	Set the "arrayFilters" field.
bsoncxx::v1::stdx::optional< bool >	bypass_document_validation () const
	Return the current "bypassDocumentValidation" field.
update_one_options &	bypass_document_validation (bool bypass_document_validation)
	Set the "bypassDocumentValidation" field.
bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view >	collation () const
	Return the current "collation" field.
update_one_options &	collation (bsoncxx::v1::document::value collation)
	Set the "collation" field.
bsoncxx::v1::stdx::optional< bsoncxx::v1::types::view > const	comment () const
	Return the current "comment" field.
update_one_options &	comment (bsoncxx::v1::types::value comment)
	Set the "comment" field.
bsoncxx::v1::stdx::optional< v1::hint >	hint () const
	Return the current "hint" field.
update_one_options &	hint (v1::hint index_hint)
	Set the "hint" field.
bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view > const	let () const
	Return the current "let" field.
update_one_options &	let (bsoncxx::v1::document::value let)
	Set the "let" field.
update_one_options &	operator= (update_one_options &&other) noexcept
	Move assignment.
update_one_options &	operator= (update_one_options const &other)
	Copy assignment.
bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view >	sort () const
	Return the current "sort" field.
update_one_options &	sort (bsoncxx::v1::document::value sort)
	Set the "sort" field.
bsoncxx::v1::stdx::optional< bool >	upsert () const
	Return the current "upsert" field.
update_one_options &	upsert (bool upsert)
	Set the "upsert" field.
bsoncxx::v1::stdx::optional< v1::write_concern >	write_concern () const
	Return the current "writeConcern" field.
update_one_options &	write_concern (v1::write_concern wc)
	Set the "writeConcern" field.

Constructor & Destructor Documentation

~update_one_options()

mongocxx::v1::update_one_options::~update_one_options

(

)

Destroy this object.

Warning

Invalidates all associated views.

update_one_options() [1/3]

mongocxx::v1::update_one_options::update_one_options ( update_one_options && other )

noexcept

Move constructor.

Postconditions:

• other is in an assign-or-destroy-only state.

update_one_options() [2/3]

mongocxx::v1::update_one_options::update_one_options

(

update_one_options const &

other

)

Copy construction.

update_one_options() [3/3]

mongocxx::v1::update_one_options::update_one_options

(

)

Default initialization.

Postconditions:

• All supported fields are "unset" or zero-initialized.

Member Function Documentation

array_filters() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::array::view > mongocxx::v1::update_one_options::array_filters

(

)

const

Return the current "arrayFilters" field.

array_filters() [2/2]

update_one_options & mongocxx::v1::update_one_options::array_filters

(

bsoncxx::v1::array::value

array_filters

)

Set the "arrayFilters" field.

bypass_document_validation() [1/2]

bsoncxx::v1::stdx::optional< bool > mongocxx::v1::update_one_options::bypass_document_validation

(

)

const

Return the current "bypassDocumentValidation" field.

bypass_document_validation() [2/2]

update_one_options & mongocxx::v1::update_one_options::bypass_document_validation

(

bool

bypass_document_validation

)

Set the "bypassDocumentValidation" field.

collation() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view > mongocxx::v1::update_one_options::collation

(

)

const

Return the current "collation" field.

collation() [2/2]

update_one_options & mongocxx::v1::update_one_options::collation

(

bsoncxx::v1::document::value

collation

)

Set the "collation" field.

comment() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::types::view > const mongocxx::v1::update_one_options::comment

(

)

const

Return the current "comment" field.

comment() [2/2]

update_one_options & mongocxx::v1::update_one_options::comment

(

bsoncxx::v1::types::value

comment

)

Set the "comment" field.

hint() [1/2]

bsoncxx::v1::stdx::optional< v1::hint > mongocxx::v1::update_one_options::hint

(

)

const

Return the current "hint" field.

hint() [2/2]

update_one_options & mongocxx::v1::update_one_options::hint

(

v1::hint

index_hint

)

Set the "hint" field.

let() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view > const mongocxx::v1::update_one_options::let

(

)

const

Return the current "let" field.

let() [2/2]

update_one_options & mongocxx::v1::update_one_options::let

(

bsoncxx::v1::document::value

let

)

Set the "let" field.

operator=() [1/2]

update_one_options & mongocxx::v1::update_one_options::operator= ( update_one_options && other )

noexcept

Move assignment.

Postconditions:

• other is in an assign-or-destroy-only state.

operator=() [2/2]

update_one_options & mongocxx::v1::update_one_options::operator=

(

update_one_options const &

other

)

Copy assignment.

sort() [1/2]

bsoncxx::v1::stdx::optional< bsoncxx::v1::document::view > mongocxx::v1::update_one_options::sort

(

)

const

Return the current "sort" field.

sort() [2/2]

update_one_options & mongocxx::v1::update_one_options::sort

(

bsoncxx::v1::document::value

sort

)

Set the "sort" field.

upsert() [1/2]

bsoncxx::v1::stdx::optional< bool > mongocxx::v1::update_one_options::upsert

(

)

const

Return the current "upsert" field.

upsert() [2/2]

update_one_options & mongocxx::v1::update_one_options::upsert

(

bool

upsert

)

Set the "upsert" field.

write_concern() [1/2]

bsoncxx::v1::stdx::optional< v1::write_concern > mongocxx::v1::update_one_options::write_concern

(

)

const

Return the current "writeConcern" field.

write_concern() [2/2]

update_one_options & mongocxx::v1::update_one_options::write_concern

(

v1::write_concern

wc

)

Set the "writeConcern" field.

---

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

• mongocxx/v1/update_one_options.hpp