MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
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 <bsoncxx/document/view_or_value.hpp>
18 #include <bsoncxx/stdx/optional.hpp>
19 #include <mongocxx/hint.hpp>
20 #include <mongocxx/write_concern.hpp>
21 
22 #include <mongocxx/config/prelude.hpp>
23 
24 namespace mongocxx {
25 MONGOCXX_INLINE_NAMESPACE_BEGIN
26 namespace options {
27 
31 class MONGOCXX_API delete_options {
32  public:
47 
57  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
58 
72 
82  const stdx::optional<class write_concern>& write_concern() const;
83 
97  delete_options& hint(class hint index_hint);
98 
104  const stdx::optional<class hint>& hint() const;
105 
106  private:
107  stdx::optional<bsoncxx::document::view_or_value> _collation;
108  stdx::optional<class write_concern> _write_concern;
109  stdx::optional<class hint> _hint;
110 };
111 
112 } // namespace options
113 MONGOCXX_INLINE_NAMESPACE_END
114 } // namespace mongocxx
115 
116 #include <mongocxx/config/postlude.hpp>
mongocxx::options::delete_options::hint
delete_options & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx::options::delete_options::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
mongocxx::write_concern
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:56
mongocxx::options::delete_options::collation
delete_options & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx::options::delete_options::write_concern
delete_options & write_concern(write_concern wc)
Sets the write_concern for this operation.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::delete_options::write_concern
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
mongocxx::options::delete_options
Class representing the optional arguments to a MongoDB delete operation.
Definition: delete.hpp:31
mongocxx::options::delete_options::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.