MongoDB C++ Driver  mongocxx-3.1.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 <mongocxx/hint.hpp>
24 #include <mongocxx/read_preference.hpp>
25 
26 #include <mongocxx/config/prelude.hpp>
27 
28 namespace mongocxx {
29 MONGOCXX_INLINE_NAMESPACE_BEGIN
30 
31 namespace options {
32 
36 class MONGOCXX_API count {
37  public:
47  count& collation(bsoncxx::document::view_or_value collation);
48 
58  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
59 
66  count& hint(class hint index_hint);
67 
73  const stdx::optional<class hint>& hint() const;
74 
81  count& limit(std::int64_t limit);
82 
88  const stdx::optional<std::int64_t>& limit() const;
89 
98  count& max_time(std::chrono::milliseconds max_time);
99 
107  const stdx::optional<std::chrono::milliseconds>& max_time() const;
108 
117  count& skip(std::int64_t skip);
118 
126  const stdx::optional<std::int64_t>& skip() const;
127 
137 
145  const stdx::optional<class read_preference>& read_preference() const;
146 
147  private:
148  stdx::optional<bsoncxx::document::view_or_value> _collation;
149  stdx::optional<class hint> _hint;
150  stdx::optional<std::int64_t> _limit;
151  stdx::optional<std::chrono::milliseconds> _max_time;
152  stdx::optional<std::int64_t> _skip;
153  stdx::optional<class read_preference> _read_preference;
154 };
155 
156 } // namespace options
157 MONGOCXX_INLINE_NAMESPACE_END
158 } // namespace mongocxx
159 
160 #include <mongocxx/config/postlude.hpp>
Definition: bulk_write.hpp:22
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:35
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:57
Class representing the optional arguments to a MongoDB count command.
Definition: count.hpp:36