MongoDB C++ Driver  mongocxx-3.9.0
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
count.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/hint.hpp>
25 #include <mongocxx/read_preference.hpp>
26 
27 #include <mongocxx/config/prelude.hpp>
28 
29 namespace mongocxx {
30 inline namespace v_noabi {
31 namespace options {
32 
36 class MONGOCXX_API count {
37  public:
50  count& collation(bsoncxx::document::view_or_value collation);
51 
60  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
61 
74  count& hint(class hint index_hint);
75 
83  const stdx::optional<class hint>& hint() const;
84 
98 
106  const stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
107 
120  count& limit(std::int64_t limit);
121 
129  const stdx::optional<std::int64_t>& limit() const;
130 
143  count& max_time(std::chrono::milliseconds max_time);
144 
152  const stdx::optional<std::chrono::milliseconds>& max_time() const;
153 
166  count& skip(std::int64_t skip);
167 
175  const stdx::optional<std::int64_t>& skip() const;
176 
190 
198  const stdx::optional<class read_preference>& read_preference() const;
199 
200  private:
201  stdx::optional<bsoncxx::document::view_or_value> _collation;
202  stdx::optional<class hint> _hint;
203  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
204  stdx::optional<std::int64_t> _limit;
205  stdx::optional<std::chrono::milliseconds> _max_time;
206  stdx::optional<std::int64_t> _skip;
207  stdx::optional<class read_preference> _read_preference;
208 };
209 
210 } // namespace options
211 } // namespace v_noabi
212 } // namespace mongocxx
213 
214 #include <mongocxx/config/postlude.hpp>
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:29
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:31
Class representing the optional arguments to mongocxx::collection::count_documents.
Definition: count.hpp:36
count & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
const stdx::optional< class hint > & hint() const
Gets the current hint.
count & limit(std::int64_t limit)
Sets the maximum number of documents to count.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
count & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const stdx::optional< std::int64_t > & skip() const
Gets the current number of documents to skip.
const stdx::optional< std::int64_t > & limit() const
Gets the current limit.
count & skip(std::int64_t skip)
Sets the number of documents to skip before counting documents.
count & read_preference(class read_preference rp)
Sets the read_preference for this operation.
count & hint(class hint index_hint)
Sets the index to use for this operation.
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