MongoDB C++ Driver 4.1.0
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
count.hpp
Go to the documentation of this file.
1// Copyright 2009-present 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
22
26
27#include <mongocxx/hint.hpp>
29
31
32namespace mongocxx {
33namespace v_noabi {
34namespace options {
35
39class count {
40 public:
55 collation(bsoncxx::v_noabi::document::view_or_value collation);
56
66 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const&)
67 collation() const;
68
83
93 hint() const;
94
109 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
110
120 bsoncxx::v_noabi::types::bson_value::view_or_value> const&)
121 comment() const;
122
137
146 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int64_t> const&) limit() const;
147
161 MONGOCXX_ABI_EXPORT_CDECL(count&) max_time(std::chrono::milliseconds max_time);
162
171 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const&)
172 max_time() const;
173
188
197 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int64_t> const&) skip() const;
198
213
224
225 private:
226 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
227 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::hint> _hint;
228 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
229 bsoncxx::v_noabi::stdx::optional<std::int64_t> _limit;
230 bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
231 bsoncxx::v_noabi::stdx::optional<std::int64_t> _skip;
232 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::read_preference> _read_preference;
233};
234
235} // namespace options
236} // namespace v_noabi
237} // namespace mongocxx
238
239#include <mongocxx/config/postlude.hpp>
240
Used by mongocxx::v_noabi::collection::count_documents.
Definition count.hpp:39
count & read_preference(mongocxx::v_noabi::read_preference rp)
Sets the read_preference for this operation.
count & skip(std::int64_t skip)
Sets the number of documents to skip before counting documents.
count & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run (server-side) in milliseconds.
count & limit(std::int64_t limit)
Sets the maximum number of documents to count.
count & hint(mongocxx::v_noabi::hint index_hint)
Sets the index to use for this operation.
count & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Set the value of the comment option.
count & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Declares mongocxx::v_noabi::options::count.
Provides bsoncxx::v_noabi::document::view_or_value.
Provides mongocxx::v_noabi::hint.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v_noabi macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
Declares entities representing options to use with various commands.
Declares entities whose ABI stability is NOT guaranteed.
The top-level namespace within which all mongocxx library entities are declared.
Provides mongocxx::v_noabi::read_preference.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
Provides std::optional-related polyfills for library API usage.