MongoDB C++ Driver  mongocxx-3.6.2
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 <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:
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 
97  count& limit(std::int64_t limit);
98 
106  const stdx::optional<std::int64_t>& limit() const;
107 
120  count& max_time(std::chrono::milliseconds max_time);
121 
129  const stdx::optional<std::chrono::milliseconds>& max_time() const;
130 
143  count& skip(std::int64_t skip);
144 
152  const stdx::optional<std::int64_t>& skip() const;
153 
167 
175  const stdx::optional<class read_preference>& read_preference() const;
176 
177  private:
178  stdx::optional<bsoncxx::document::view_or_value> _collation;
179  stdx::optional<class hint> _hint;
180  stdx::optional<std::int64_t> _limit;
181  stdx::optional<std::chrono::milliseconds> _max_time;
182  stdx::optional<std::int64_t> _skip;
183  stdx::optional<class read_preference> _read_preference;
184 };
185 
186 } // namespace options
187 MONGOCXX_INLINE_NAMESPACE_END
188 } // namespace mongocxx
189 
190 #include <mongocxx/config/postlude.hpp>
mongocxx::options::count::skip
const stdx::optional< std::int64_t > & skip() const
Gets the current number of documents to skip.
mongocxx::options::count::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
bsoncxx::view_or_value< document::view, document::value >
mongocxx::options::count::collation
count & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx::options::count::max_time
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
mongocxx::options::count::hint
count & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx::options::count::read_preference
count & read_preference(class read_preference rp)
Sets the read_preference for this operation.
mongocxx::options::count::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
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::count::max_time
count & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
mongocxx::options::count::skip
count & skip(std::int64_t skip)
Sets the number of documents to skip before counting documents.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::count::read_preference
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
mongocxx::options::count::limit
count & limit(std::int64_t limit)
Sets the maximum number of documents to count.
mongocxx::options::count
Class representing the optional arguments to mongocxx::collection::count_documents.
Definition: count.hpp:36
mongocxx::options::count::limit
const stdx::optional< std::int64_t > & limit() const
Gets the current limit.