MongoDB C++ Driver mongocxx-3.11.0
Loading...
Searching...
No Matches
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(const stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
67 collation() const;
68
83
92 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::hint>&) hint() const;
93
108 comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment);
109
119 const stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value>&)
120 comment() const;
121
136
145 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::int64_t>&) limit() const;
146
161
170 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::chrono::milliseconds>&) max_time() const;
171
186
195 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<std::int64_t>&) skip() const;
196
211
220 MONGOCXX_ABI_EXPORT_CDECL(const stdx::optional<mongocxx::v_noabi::read_preference>&)
222
223 private:
224 stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
225 stdx::optional<mongocxx::v_noabi::hint> _hint;
226 stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
227 stdx::optional<std::int64_t> _limit;
228 stdx::optional<std::chrono::milliseconds> _max_time;
229 stdx::optional<std::int64_t> _skip;
230 stdx::optional<mongocxx::v_noabi::read_preference> _read_preference;
231};
232
233} // namespace options
234} // namespace v_noabi
235} // namespace mongocxx
236
237#include <mongocxx/config/postlude.hpp>
238
Class representing a hint to be passed to a database operation.
Definition hint.hpp:37
Class representing the optional arguments to mongocxx::v_noabi::collection::count_documents.
Definition count.hpp:39
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
const stdx::optional< std::int64_t > & limit() const
Gets the current limit.
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & comment() const
Gets the current value of the comment option.
const stdx::optional< std::int64_t > & skip() const
Gets the current number of documents to skip.
const stdx::optional< bsoncxx::v_noabi::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition read_preference.hpp:65
Declares mongocxx::v_noabi::options::count.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:222
Provides mongocxx::v_noabi::hint.
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Provides std::optional-related polyfills for library API usage.
Provides mongocxx::v_noabi::read_preference.
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.