MongoDB C++ Driver  mongocxx-3.7.0
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 MONGOCXX_INLINE_NAMESPACE_BEGIN
31 
32 namespace options {
33 
37 class MONGOCXX_API count {
38  public:
51  count& collation(bsoncxx::document::view_or_value collation);
52 
61  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
62 
75  count& hint(class hint index_hint);
76 
84  const stdx::optional<class hint>& hint() const;
85 
99 
107  const stdx::optional<bsoncxx::types::bson_value::view_or_value>& comment() const;
108 
121  count& limit(std::int64_t limit);
122 
130  const stdx::optional<std::int64_t>& limit() const;
131 
144  count& max_time(std::chrono::milliseconds max_time);
145 
153  const stdx::optional<std::chrono::milliseconds>& max_time() const;
154 
167  count& skip(std::int64_t skip);
168 
176  const stdx::optional<std::int64_t>& skip() const;
177 
191 
199  const stdx::optional<class read_preference>& read_preference() const;
200 
201  private:
202  stdx::optional<bsoncxx::document::view_or_value> _collation;
203  stdx::optional<class hint> _hint;
204  stdx::optional<bsoncxx::types::bson_value::view_or_value> _comment;
205  stdx::optional<std::int64_t> _limit;
206  stdx::optional<std::chrono::milliseconds> _max_time;
207  stdx::optional<std::int64_t> _skip;
208  stdx::optional<class read_preference> _read_preference;
209 };
210 
211 } // namespace options
212 MONGOCXX_INLINE_NAMESPACE_END
213 } // namespace mongocxx
214 
215 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
bsoncxx::view_or_value
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
mongocxx::read_preference
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:63
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::count
Class representing the optional arguments to mongocxx::collection::count_documents.
Definition: count.hpp:37