MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
delete_many.hpp
1 // Copyright 2014 MongoDB Inc.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #pragma once
16 
17 #include <bsoncxx/document/view_or_value.hpp>
18 #include <bsoncxx/stdx/optional.hpp>
19 #include <mongocxx/hint.hpp>
20 #include <mongocxx/stdx.hpp>
21 
22 #include <mongocxx/config/prelude.hpp>
23 
24 namespace mongocxx {
25 MONGOCXX_INLINE_NAMESPACE_BEGIN
26 namespace model {
27 
31 class MONGOCXX_API delete_many {
32  public:
40 
47 
62 
72  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
73 
86  delete_many& hint(class hint index_hint);
87 
93  const stdx::optional<class hint>& hint() const;
94 
95  private:
97 
98  stdx::optional<bsoncxx::document::view_or_value> _collation;
99  stdx::optional<class hint> _hint;
100 };
101 
102 } // namespace model
103 MONGOCXX_INLINE_NAMESPACE_END
104 } // namespace mongocxx
105 
106 #include <mongocxx/config/postlude.hpp>
mongocxx::model::delete_many::collation
delete_many & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this delete operation.
mongocxx::model::delete_many::hint
delete_many & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value< document::view, document::value >
mongocxx::model::delete_many::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
mongocxx::model::delete_many
Class representing a MongoDB delete operation that removes multiple documents.
Definition: delete_many.hpp:31
mongocxx::model::delete_many::delete_many
delete_many(bsoncxx::document::view_or_value filter)
Constructs a delete operation that will delete all documents matching the filter.
mongocxx::model::delete_many::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Gets the collation option for this delete operation.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::model::delete_many::filter
const bsoncxx::document::view_or_value & filter() const
Gets the filter for this delete operation.