MongoDB C++ Driver  mongocxx-3.10.2
delete.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/options/delete-fwd.hpp>
18 
19 #include <bsoncxx/document/view_or_value.hpp>
20 #include <bsoncxx/stdx/optional.hpp>
21 #include <bsoncxx/types/bson_value/view_or_value.hpp>
22 #include <mongocxx/hint.hpp>
23 #include <mongocxx/write_concern.hpp>
24 
25 #include <mongocxx/config/prelude.hpp>
26 
27 namespace mongocxx {
28 namespace v_noabi {
29 namespace options {
30 
35  public:
50 
60  const stdx::optional<bsoncxx::v_noabi::document::view_or_value>& collation() const;
61 
75 
85  const stdx::optional<mongocxx::v_noabi::write_concern>& write_concern() const;
86 
101 
107  const stdx::optional<mongocxx::v_noabi::hint>& hint() const;
108 
120 
127  const stdx::optional<bsoncxx::v_noabi::document::view_or_value> let() const;
128 
140 
147  const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> comment() const;
148 
149  private:
150  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
151  stdx::optional<mongocxx::v_noabi::write_concern> _write_concern;
152  stdx::optional<mongocxx::v_noabi::hint> _hint;
153  stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
154  stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
155 };
156 
157 } // namespace options
158 } // namespace v_noabi
159 } // namespace mongocxx
160 
161 #include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:34
Class representing the optional arguments to a MongoDB delete operation.
Definition: delete.hpp:34
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
delete_options & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
delete_options & write_concern(write_concern wc)
Sets the write_concern for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const stdx::optional< mongocxx::v_noabi::write_concern > & write_concern() const
The current write_concern for this operation.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > let() const
Gets the current value of the let option.
delete_options & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< mongocxx::v_noabi::hint > & hint() const
Gets the current hint.
delete_options & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
delete_options & let(bsoncxx::v_noabi::document::view_or_value let)
Set the value of the let option.
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:58
The top-level namespace for mongocxx library entities.
Definition: bulk_write-fwd.hpp:19