MongoDB C++ Driver  mongocxx-3.10.2
delete_one.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 <mongocxx/model/delete_one-fwd.hpp>
18 
19 #include <bsoncxx/document/view_or_value.hpp>
20 #include <bsoncxx/stdx/optional.hpp>
21 #include <mongocxx/hint.hpp>
22 #include <mongocxx/stdx.hpp>
23 
24 #include <mongocxx/config/prelude.hpp>
25 
26 namespace mongocxx {
27 namespace v_noabi {
28 namespace model {
29 
33 class delete_one {
34  public:
42 
49 
60 
70  const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
71 
86 
92  const stdx::optional<mongocxx::v_noabi::hint>& hint() const;
93 
94  private:
96 
97  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
98  stdx::optional<mongocxx::v_noabi::hint> _hint;
99 };
100 
101 } // namespace model
102 } // namespace v_noabi
103 } // namespace mongocxx
104 
105 #include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:34
Class representing a MongoDB delete operation that removes a single document.
Definition: delete_one.hpp:33
delete_one & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this delete operation.
delete_one(bsoncxx::v_noabi::document::view_or_value filter)
Constructs a delete operation that will delete the first document matching the filter.
const bsoncxx::v_noabi::document::view_or_value & filter() const
Gets the filter on this delete operation.
delete_one & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Gets the collation option for this delete operation.
The top-level namespace for mongocxx library entities.
Definition: bulk_write-fwd.hpp:19