mongocxx::options::delete_options Class Reference

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

#include <delete.hpp>

Public Member Functions
delete_options &	collation (bsoncxx::document::view_or_value collation)
	Sets the collation for this operation. More...
const stdx::optional< bsoncxx::document::view_or_value > &	collation () const
	Retrieves the current collation for this operation. More...
delete_options &	write_concern (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...
delete_options &	hint (class hint index_hint)
	Sets the index to use for this operation. More...
const stdx::optional< class hint > &	hint () const
	Gets the current hint. More...
delete_options &	let (bsoncxx::document::view_or_value let)
	Set the value of the let option. More...
const stdx::optional< bsoncxx::document::view_or_value >	let () const
	Gets the current value of the let option. More...
delete_options &	comment (bsoncxx::types::bson_value::view_or_value comment)
	Set the value of the comment option. More...
const stdx::optional< bsoncxx::types::bson_value::view_or_value >	comment () const
	Gets the current value of the comment option. More...

Detailed Description

Class representing the optional arguments to a MongoDB delete operation.

Member Function Documentation

collation() [1/2]

const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::delete_options::collation

(

)

const

Retrieves the current collation for this operation.

Returns

The current collation.

See also

https://docs.mongodb.com/manual/reference/collation/

collation() [2/2]

delete_options& mongocxx::options::delete_options::collation

(

bsoncxx::document::view_or_value

collation

)

Sets the collation for this operation.

Parameters

collation

The new collation.

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/collation/

comment() [1/2]

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

(

)

const

Gets the current value of the comment option.

Returns

The current comment option.

comment() [2/2]

delete_options& mongocxx::options::delete_options::comment

(

bsoncxx::types::bson_value::view_or_value

comment

)

Set the value of the comment option.

Parameters

comment

The new comment option.

Returns

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

hint() [1/2]

const stdx::optional<class hint>& mongocxx::options::delete_options::hint

(

)

const

Gets the current hint.

Returns

The current hint, if one is set.

hint() [2/2]

delete_options& mongocxx::options::delete_options::hint

(

class hint

index_hint

)

Sets the index to use for this operation.

Note

if the server already has a cached shape for this query, it may ignore a hint.

Parameters

index_hint

Object representing the index to use.

Returns

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

let() [1/2]

const stdx::optional<bsoncxx::document::view_or_value> mongocxx::options::delete_options::let

(

)

const

Gets the current value of the let option.

Returns

The current let option.

let() [2/2]

delete_options& mongocxx::options::delete_options::let

(

bsoncxx::document::view_or_value

let

)

Set the value of the let option.

Parameters

let	The new let option.

Returns

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

write_concern() [1/2]

const stdx::optional<class write_concern>& mongocxx::options::delete_options::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]

delete_options& mongocxx::options::delete_options::write_concern

(

write_concern

wc

)

Sets the write_concern for this operation.

Parameters

wc	The new write_concern.

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/core/write-concern/

---

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

• src/mongocxx/options/delete.hpp