MongoDB C++ Driver 4.2.0
Loading...
Searching...
No Matches
distinct.hpp
Go to the documentation of this file.
1// Copyright 2009-present 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/distinct-fwd.hpp> // IWYU pragma: export
18
19//
20
21#include <mongocxx/v1/distinct_options.hpp> // IWYU pragma: export
22
23#include <chrono>
24#include <cstdint> // IWYU pragma: keep: backward compatibility, to be removed.
25#include <string> // IWYU pragma: keep: backward compatibility, to be removed.
26#include <utility>
27
35
37
39
40namespace mongocxx {
41namespace v_noabi {
42namespace options {
43
47class distinct {
48 public:
52 distinct() = default;
53
57 /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() distinct(v1::distinct_options opts);
58
62 explicit operator v1::distinct_options() const {
64
66
67 if (_collation) {
68 ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
69 }
70
71 if (_max_time) {
72 ret.max_time(*_max_time);
73 }
74
75 if (_comment) {
76 ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
77 }
78
79 if (_read_preference) {
80 ret.read_preference(to_v1(*_read_preference));
81 }
82
83 return ret;
84 }
85
100 _collation = std::move(collation);
101 return *this;
102 }
103
116
130 distinct& max_time(std::chrono::milliseconds max_time) {
131 _max_time = max_time;
132 return *this;
133 }
134
144 return _max_time;
145 }
146
161 _comment = std::move(comment);
162 return *this;
163 }
164
176
191 _read_preference = std::move(rp);
192 return *this;
193 }
194
204 return _read_preference;
205 }
206
207 private:
212};
213
214} // namespace options
215} // namespace v_noabi
216} // namespace mongocxx
217
218namespace mongocxx {
219namespace v_noabi {
220
225 return {std::move(v)};
226}
227
233
234} // namespace v_noabi
235} // namespace mongocxx
236
238
A BSON document.
Definition value.hpp:46
A polyfill for std::optional<T>.
Definition optional.hpp:799
A union of BSON type values.
Definition value.hpp:54
distinct()=default
Default initialization.
Options for a "distinct" command.
Definition distinct_options.hpp:51
distinct_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
distinct_options & max_time(std::chrono::milliseconds max_time)
Set the "maxTimeMS" field.
distinct_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
distinct_options & read_preference(v1::read_preference rp)
Set the "readPreference" field.
Used by mongocxx::v_noabi::collection.
Definition distinct.hpp:47
bsoncxx::v_noabi::stdx::optional< v_noabi::read_preference > const & read_preference() const
The current read_preference for this operation.
Definition distinct.hpp:203
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const & comment() const
The current comment for this operation.
Definition distinct.hpp:173
distinct & read_preference(v_noabi::read_preference rp)
Sets the read_preference for this operation.
Definition distinct.hpp:190
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition distinct.hpp:113
distinct()=default
Default initialization.
operator v1::distinct_options() const
Convert to the mongocxx::v1 equivalent.
Definition distinct.hpp:62
distinct & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition distinct.hpp:99
distinct & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Definition distinct.hpp:130
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition distinct.hpp:143
distinct & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Sets the comment for this operation.
Definition distinct.hpp:160
Describes how MongoDB clients route read operations to the members of a replica set or sharded cluste...
Definition read_preference.hpp:59
Declares mongocxx::v_noabi::options::distinct.
Provides mongocxx::v1::distinct_options.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard postlude header.
The mongocxx v_noabi macro guard prelude header.
v_noabi::view_or_value< v_noabi::document::view, v_noabi::document::value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::document::view, v_noabi::document::value>.
Definition view_or_value.hpp:30
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<view, value>.
Definition view_or_value.hpp:31
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
Declares entities whose ABI stability is guaranteed for documented symbols.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
The top-level namespace within which all mongocxx library entities are declared.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides bsoncxx::v_noabi::document::value.
Provides bsoncxx::v_noabi::document::view.
Provides std::optional-related polyfills for library API usage.
Provides bsoncxx::v_noabi::types::bson_value::value.
Provides bsoncxx::v_noabi::types::bson_value::view.
Provides mongocxx::v_noabi::read_preference.