mongocxx::options::insert Class Reference

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

#include <insert.hpp>

Public Member Functions
insert &	bypass_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...
insert &	write_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...
insert &	ordered (bool ordered)
const stdx::optional< bool > &	ordered () const
	The current ordered value for this operation. More...
insert &	comment (bsoncxx::types::bson_value::view_or_value comment)
	Sets the comment for this operation. More...
const stdx::optional< bsoncxx::types::bson_value::view_or_value > &	comment () const
	The current comment for this operation. More...

Detailed Description

Class representing the optional arguments to a MongoDB insert operation.

Member Function Documentation

bypass_document_validation() [1/2]

const stdx::optional<bool>& mongocxx::options::insert::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]

insert& mongocxx::options::insert::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

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

comment() [1/2]

const stdx::optional<bsoncxx::types::bson_value::view_or_value>& mongocxx::options::insert::comment

(

)

const

The current comment for this operation.

Returns

The current comment.

See also

https://docs.mongodb.com/manual/reference/command/insert/

comment() [2/2]

insert& mongocxx::options::insert::comment

(

bsoncxx::types::bson_value::view_or_value

comment

)

Sets the comment for this operation.

Parameters

comment

The new comment.

See also

https://docs.mongodb.com/manual/reference/command/insert/

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

ordered() [1/2]

const stdx::optional<bool>& mongocxx::options::insert::ordered

(

)

const

The current ordered value for this operation.

Returns

The current ordered value.

See also

https://docs.mongodb.com/manual/reference/command/insert/

ordered() [2/2]

insert& mongocxx::options::insert::ordered

(

bool

ordered

)

Note

: This applies only to insert_many and is ignored for insert_one.

If true, when an insert fails, return without performing the remaining writes. If false, when a write fails, continue with the remaining writes, if any. Inserts can be performed in any order if this is false. Defaults to true.

Parameters

ordered

Whether or not the insert_many will be ordered.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

See also

https://docs.mongodb.com/manual/reference/command/insert/

write_concern() [1/2]

const stdx::optional<class write_concern>& mongocxx::options::insert::write_concern

(

)

const

The current write_concern for this operation.

Returns

The current write_concern.

See also

https://docs.mongodb.com/manual/core/write-concern/

write_concern() [2/2]

insert& mongocxx::options::insert::write_concern

(

class write_concern

wc

)

Sets the write_concern for this operation.

Parameters

wc	The new write_concern.

See also

https://docs.mongodb.com/manual/core/write-concern/

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

---

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

• src/mongocxx/options/insert.hpp