MongoDB C++ Driver mongocxx-3.7.0
Loading...
Searching...
No Matches
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
29namespace mongocxx {
30MONGOCXX_INLINE_NAMESPACE_BEGIN
31
32namespace options {
33
37class MONGOCXX_API count {
38 public:
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
212MONGOCXX_INLINE_NAMESPACE_END
213} // namespace mongocxx
214
215#include <mongocxx/config/postlude.hpp>
Class representing a hint to be passed to a database operation.
Definition hint.hpp:32
Class representing the optional arguments to mongocxx::collection::count_documents.
Definition count.hpp:37
count & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
count & skip(std::int64_t skip)
Sets the number of documents to skip before counting documents.
const stdx::optional< bsoncxx::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
const stdx::optional< class hint > & hint() const
Gets the current hint.
const stdx::optional< std::int64_t > & limit() const
Gets the current limit.
count & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
count & hint(class hint index_hint)
Sets the index to use for this operation.
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
const stdx::optional< std::int64_t > & skip() const
Gets the current number of documents to skip.
count & comment(bsoncxx::types::bson_value::view_or_value comment)
Set the value of the comment option.
count & limit(std::int64_t limit)
Sets the maximum number of documents to count.
count & read_preference(class read_preference rp)
Sets the read_preference for this operation.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition read_preference.hpp:63
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:24