MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
mongocxx::v_noabi::options::delete_options Class Reference

#include <mongocxx/v_noabi/mongocxx/options/delete.hpp>

Description

Class representing the optional arguments to a MongoDB delete operation.

Public Member Functions

const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation () const
 Retrieves the current collation for this operation.
 
delete_optionscollation (bsoncxx::v_noabi::document::view_or_value collation)
 Sets the collation for this operation.
 
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_valuecomment () const
 Gets the current value of the comment option.
 
delete_optionscomment (bsoncxx::v_noabi::types::bson_value::view_or_value comment)
 Set the value of the comment option.
 
const stdx::optional< mongocxx::v_noabi::hint > & hint () const
 Gets the current hint.
 
delete_optionshint (mongocxx::v_noabi::hint index_hint)
 Sets the index to use for this operation.
 
const stdx::optional< bsoncxx::v_noabi::document::view_or_valuelet () const
 Gets the current value of the let option.
 
delete_optionslet (bsoncxx::v_noabi::document::view_or_value let)
 Set the value of the let option.
 
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern () const
 The current write_concern for this operation.
 
delete_optionswrite_concern (write_concern wc)
 Sets the write_concern for this operation.
 

Member Function Documentation

◆ collation() [1/2]

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

Retrieves the current collation for this operation.

Returns
The current collation.
See also

◆ collation() [2/2]

delete_options & mongocxx::v_noabi::options::delete_options::collation ( bsoncxx::v_noabi::document::view_or_value collation)

Sets the collation for this operation.

Parameters
collationThe new collation.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also

◆ comment() [1/2]

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

Gets the current value of the comment option.

Returns
The current comment option.

◆ comment() [2/2]

delete_options & mongocxx::v_noabi::options::delete_options::comment ( bsoncxx::v_noabi::types::bson_value::view_or_value comment)

Set the value of the comment option.

Parameters
commentThe 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< mongocxx::v_noabi::hint > & mongocxx::v_noabi::options::delete_options::hint ( ) const

Gets the current hint.

Returns
The current hint, if one is set.

◆ hint() [2/2]

delete_options & mongocxx::v_noabi::options::delete_options::hint ( mongocxx::v_noabi::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_hintObject 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::v_noabi::document::view_or_value > mongocxx::v_noabi::options::delete_options::let ( ) const

Gets the current value of the let option.

Returns
The current let option.

◆ let() [2/2]

delete_options & mongocxx::v_noabi::options::delete_options::let ( bsoncxx::v_noabi::document::view_or_value let)

Set the value of the let option.

Parameters
letThe 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< mongocxx::v_noabi::write_concern > & mongocxx::v_noabi::options::delete_options::write_concern ( ) const

The current write_concern for this operation.

Returns
The current write_concern.
See also

◆ write_concern() [2/2]

delete_options & mongocxx::v_noabi::options::delete_options::write_concern ( write_concern wc)

Sets the write_concern for this operation.

Parameters
wcThe new write_concern.
Returns
A reference to the object on which this member function is being called. This facilitates method chaining.
See also

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