mongocxx::model::delete_many Class Reference

Class representing a MongoDB delete operation that removes multiple documents. More...

#include <delete_many.hpp>

Public Member Functions
	delete_many (bsoncxx::document::view_or_value filter)
	Constructs a delete operation that will delete all documents matching the filter.
const bsoncxx::document::view_or_value &	filter () const
	Gets the filter for this delete operation.
delete_many &	collation (bsoncxx::document::view_or_value collation)
	Sets the collation for this delete operation.
const stdx::optional< bsoncxx::document::view_or_value > &	collation () const
	Gets the collation option for this delete operation.
delete_many &	hint (class hint index_hint)
	Sets the index to use for this operation.
const stdx::optional< class hint > &	hint () const
	Gets the current hint.

Detailed Description

Class representing a MongoDB delete operation that removes multiple documents.

Constructor & Destructor Documentation

delete_many()

mongocxx::model::delete_many::delete_many ( bsoncxx::document::view_or_value  filter )

explicit

Constructs a delete operation that will delete all documents matching the filter.

Parameters

filter

Document representing the criteria for deletion.

Member Function Documentation

collation() [1/2]

const stdx::optional< bsoncxx::document::view_or_value > & mongocxx::model::delete_many::collation

(

)

const

Gets the collation option for this delete operation.

Returns

The optional value of the collation option.

See also

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

collation() [2/2]

delete_many & mongocxx::model::delete_many::collation

(

bsoncxx::document::view_or_value

collation

)

Sets the collation for this delete 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/

filter()

const bsoncxx::document::view_or_value & mongocxx::model::delete_many::filter

(

)

const

Gets the filter for this delete operation.

Returns

The filter to be used for the delete operation.

hint() [1/2]

const stdx::optional< class hint > & mongocxx::model::delete_many::hint

(

)

const

Gets the current hint.

Returns

The current hint, if one is set.

hint() [2/2]

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

---

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

• src/mongocxx/model/delete_many.hpp