MongoDB C++ Driver mongocxx-3.7.0
Loading...
Searching...
No Matches
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 <bsoncxx/types/bson_value/view_or_value.hpp>
20#include <mongocxx/hint.hpp>
21#include <mongocxx/write_concern.hpp>
22
23#include <mongocxx/config/prelude.hpp>
24
25namespace mongocxx {
26MONGOCXX_INLINE_NAMESPACE_BEGIN
27namespace options {
28
32class MONGOCXX_API delete_options {
33 public:
48
58 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
59
73
83 const stdx::optional<class write_concern>& write_concern() const;
84
98 delete_options& hint(class hint index_hint);
99
105 const stdx::optional<class hint>& hint() const;
106
118
125 const stdx::optional<bsoncxx::document::view_or_value> let() const;
126
138
145 const stdx::optional<bsoncxx::types::bson_value::view_or_value> comment() const;
146
147 private:
148 stdx::optional<bsoncxx::document::view_or_value> _collation;
149 stdx::optional<class write_concern> _write_concern;
150 stdx::optional<class hint> _hint;
151 stdx::optional<bsoncxx::document::view_or_value> _let;
152 stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
153};
154
155} // namespace options
156MONGOCXX_INLINE_NAMESPACE_END
157} // namespace mongocxx
158
159#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition hint.hpp:32
Class representing the optional arguments to a MongoDB delete operation.
Definition delete.hpp:32
delete_options & hint(class hint index_hint)
Sets the index to use for this operation.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
delete_options & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< class hint > & hint() const
Gets the current hint.
delete_options & let(bsoncxx::document::view_or_value let)
Set the value of the let option.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > comment() const
Gets the current value of the comment option.
delete_options & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
delete_options & write_concern(write_concern wc)
Sets the write_concern for this operation.
const stdx::optional< bsoncxx::document::view_or_value > let() const
Gets the current value of the let option.
const stdx::optional< class write_concern > & write_concern() const
The current write_concern for this operation.
Class representing the server-side requirement for reporting the success of a write operation.
Definition write_concern.hpp:56
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24