MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
estimated_document_count.hpp
1 // Copyright 2018-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 <chrono>
18 
19 #include <bsoncxx/stdx/optional.hpp>
20 #include <bsoncxx/types/bson_value/view_or_value.hpp>
21 #include <mongocxx/read_preference.hpp>
22 
23 #include <mongocxx/config/prelude.hpp>
24 
25 namespace mongocxx {
26 inline namespace v_noabi {
27 namespace options {
28 
32 class MONGOCXX_API estimated_document_count {
33  public:
46  estimated_document_count& max_time(std::chrono::milliseconds max_time);
47 
55  const bsoncxx::stdx::optional<std::chrono::milliseconds>& max_time() const;
56 
70 
78  const bsoncxx::stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
79 
93 
101  const bsoncxx::stdx::optional<class read_preference>& read_preference() const;
102 
103  private:
104  bsoncxx::stdx::optional<std::chrono::milliseconds> _max_time;
105  bsoncxx::stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
106  bsoncxx::stdx::optional<class read_preference> _read_preference;
107 };
108 
109 } // namespace options
110 } // namespace v_noabi
111 } // namespace mongocxx
112 
113 #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 mongocxx::collection::estimated_document_count.
Definition: estimated_document_count.hpp:32
estimated_document_count & read_preference(class read_preference rp)
Sets the read_preference for this operation.
const bsoncxx::stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const bsoncxx::stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
const bsoncxx::stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
The current comment for this operation.
estimated_document_count & comment(bsoncxx::types::bson_value::view_or_value comment)
Sets the comment for this operation.
estimated_document_count & 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