MongoDB C++ Driver  mongocxx-3.6.2
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 <mongocxx/read_preference.hpp>
24 
25 #include <mongocxx/config/prelude.hpp>
26 
27 namespace mongocxx {
28 MONGOCXX_INLINE_NAMESPACE_BEGIN
29 namespace options {
30 
34 class MONGOCXX_API distinct {
35  public:
49 
58  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
59 
72  distinct& max_time(std::chrono::milliseconds max_time);
73 
81  const stdx::optional<std::chrono::milliseconds>& max_time() const;
82 
96 
104  const stdx::optional<class read_preference>& read_preference() const;
105 
106  private:
107  stdx::optional<bsoncxx::document::view_or_value> _collation;
108  stdx::optional<std::chrono::milliseconds> _max_time;
109  stdx::optional<class read_preference> _read_preference;
110 };
111 
112 } // namespace options
113 MONGOCXX_INLINE_NAMESPACE_END
114 } // namespace mongocxx
115 
116 #include <mongocxx/config/postlude.hpp>
mongocxx::options::distinct::collation
distinct & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx::options::distinct::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::options::distinct::read_preference
distinct & read_preference(class read_preference rp)
Sets the read_preference for this operation.
bsoncxx::view_or_value< document::view, document::value >
mongocxx::options::distinct::max_time
distinct & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
mongocxx::options::distinct
Class representing the optional arguments to a MongoDB distinct command.
Definition: distinct.hpp:34
mongocxx::read_preference
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:62
mongocxx::options::distinct::read_preference
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
mongocxx::options::distinct::max_time
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.