MongoDB C++ Driver mongocxx-3.6.7
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 <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
24namespace mongocxx {
25MONGOCXX_INLINE_NAMESPACE_BEGIN
26namespace model {
27
31class MONGOCXX_API delete_one {
32 public:
40
47
58
68 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
69
83 delete_one& hint(class hint index_hint);
84
90 const stdx::optional<class hint>& hint() const;
91
92 private:
94
95 stdx::optional<bsoncxx::document::view_or_value> _collation;
96 stdx::optional<class hint> _hint;
97};
98
99} // namespace model
100MONGOCXX_INLINE_NAMESPACE_END
101} // namespace mongocxx
102
103#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
Class representing a MongoDB delete operation that removes a single document.
Definition: delete_one.hpp:31
delete_one & hint(class hint index_hint)
Sets the index to use for this operation.
delete_one & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this delete operation.
delete_one(bsoncxx::document::view_or_value filter)
Constructs a delete operation that will delete the first document matching the filter.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Gets the collation option for this delete operation.
const bsoncxx::document::view_or_value & filter() const
Gets the filter on this delete operation.
const stdx::optional< class hint > & hint() const
Gets the current hint.
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24