MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
distinct.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 <chrono>
18 #include <cstdint>
19 #include <string>
20 
21 #include <bsoncxx/document/view_or_value.hpp>
22 #include <bsoncxx/stdx/optional.hpp>
23 #include <bsoncxx/types/bson_value/view_or_value.hpp>
24 #include <mongocxx/read_preference.hpp>
25 
26 #include <mongocxx/config/prelude.hpp>
27 
28 namespace mongocxx {
29 inline namespace v_noabi {
30 namespace options {
31 
35 class MONGOCXX_API distinct {
36  public:
49  distinct& collation(bsoncxx::document::view_or_value collation);
50 
59  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
60 
73  distinct& max_time(std::chrono::milliseconds max_time);
74 
82  const stdx::optional<std::chrono::milliseconds>& max_time() const;
83 
97 
105  const stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
106 
120 
128  const stdx::optional<class read_preference>& read_preference() const;
129 
130  private:
131  stdx::optional<bsoncxx::document::view_or_value> _collation;
132  stdx::optional<std::chrono::milliseconds> _max_time;
133  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
134  stdx::optional<class read_preference> _read_preference;
135 };
136 
137 } // namespace options
138 } // namespace v_noabi
139 } // namespace mongocxx
140 
141 #include <mongocxx/config/postlude.hpp>
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:29
Class representing the optional arguments to a MongoDB distinct command.
Definition: distinct.hpp:35
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
distinct & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
distinct & read_preference(class read_preference rp)
Sets the read_preference for this operation.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
The current comment for this operation.
distinct & comment(bsoncxx::types::bson_value::view_or_value comment)
Sets the comment for this operation.
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
distinct & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:67
The top-level namespace for mongocxx library entities.
Definition: bulk_write.hpp:24