MongoDB C++ Driver mongocxx-3.6.7
Public Member Functions | List of all members
mongocxx::options::delete_options Class Reference

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

#include <delete.hpp>

Public Member Functions

delete_optionscollation (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_optionswrite_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_optionshint (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...
 

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/master/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
collationThe 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/master/reference/collation/

◆ 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_hintObject representing the index to use.
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/master/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
wcThe 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/master/core/write-concern/

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