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

#include <mongocxx/v_noabi/mongocxx/model/delete_one.hpp>

Description

Class representing a MongoDB delete operation that removes a single document.

Public Member Functions

 delete_one (bsoncxx::v_noabi::document::view_or_value filter)
 Constructs a delete operation that will delete the first document matching the filter.
 
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation () const
 Gets the collation option for this delete operation.
 
delete_onecollation (bsoncxx::v_noabi::document::view_or_value collation)
 Sets the collation for this delete operation.
 
const bsoncxx::v_noabi::document::view_or_valuefilter () const
 Gets the filter on this delete operation.
 
const stdx::optional< mongocxx::v_noabi::hint > & hint () const
 Gets the current hint.
 
delete_onehint (mongocxx::v_noabi::hint index_hint)
 Sets the index to use for this operation.
 

Constructor & Destructor Documentation

◆ delete_one()

mongocxx::v_noabi::model::delete_one::delete_one ( bsoncxx::v_noabi::document::view_or_value filter)

Constructs a delete operation that will delete the first document matching the filter.

Parameters
filterDocument representing the criteria for deletion.

Member Function Documentation

◆ collation() [1/2]

const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & mongocxx::v_noabi::model::delete_one::collation ( ) const

Gets the collation option for this delete operation.

Returns
The optional value of the collation option.
See also

◆ collation() [2/2]

delete_one & mongocxx::v_noabi::model::delete_one::collation ( bsoncxx::v_noabi::document::view_or_value collation)

Sets the collation for this delete operation.

Parameters
collationThe new collation.
See also

◆ filter()

const bsoncxx::v_noabi::document::view_or_value & mongocxx::v_noabi::model::delete_one::filter ( ) const

Gets the filter on this delete operation.

Returns
The filter to be used for the delete operation.

◆ hint() [1/2]

const stdx::optional< mongocxx::v_noabi::hint > & mongocxx::v_noabi::model::delete_one::hint ( ) const

Gets the current hint.

Returns
The current hint, if one is set.

◆ hint() [2/2]

delete_one & mongocxx::v_noabi::model::delete_one::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.

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