MongoDB C++ Driver 4.2.0
Loading...
Searching...
No Matches
aggregate_options.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 <mongocxx/v1/aggregate_options-fwd.hpp> // IWYU pragma: export
18
19//
20
22
27
32
34
36
37#include <chrono>
38#include <cstdint>
39
40namespace mongocxx {
41namespace v1 {
42
65 private:
66 class impl;
67 void* _impl;
68
69 public:
76
84
92
97
102
110
115
119 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) allow_disk_use() const;
120
125
129 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::int32_t>) batch_size() const;
130
135
139 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;
140
145
149 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) let() const;
150
155
159 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<std::chrono::milliseconds>) max_time() const;
160
165
170
175
180
185
189 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;
190
195
200
205
210
215
219 MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::types::view>) comment() const;
220
221 class internal;
222};
223
224} // namespace v1
225} // namespace mongocxx
226
227#include <mongocxx/v1/detail/postlude.hpp>
228
Declares mongocxx::v1::aggregate_options.
aggregate_options & allow_disk_use(bool allow_disk_use)
Set the "allowDiskUse" field.
aggregate_options & write_concern(v1::write_concern write_concern)
Set the "writeConcern" field.
aggregate_options & max_time(std::chrono::milliseconds max_time)
Set the "maxTimeMS" field.
aggregate_options & hint(v1::hint index_hint)
Set the "hint" field.
aggregate_options & let(bsoncxx::v1::document::value let)
Set the "let" field.
aggregate_options & read_concern(v1::read_concern read_concern)
Set the "readConcern" field.
~aggregate_options()
Destroy this object.
aggregate_options & read_preference(v1::read_preference rp)
Set the "readPreference" field.
aggregate_options & bypass_document_validation(bool bypass_document_validation)
Set the "bypassDocumentValidation" field.
aggregate_options & comment(bsoncxx::v1::types::value comment)
Set the "comment" field.
aggregate_options & batch_size(std::int32_t batch_size)
Set the "batchSize" field.
aggregate_options & collation(bsoncxx::v1::document::value collation)
Set the "collation" field.
aggregate_options(aggregate_options &&other) noexcept
Move constructor.
Provides macros to control the set of symbols exported in the ABI.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition export.hpp:52
The mongocxx v1 macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
Declares entities whose ABI stability is guaranteed for documented symbols.
The top-level namespace within which all mongocxx library entities are declared.
Declares bsoncxx::v1::document::value.
Declares bsoncxx::v1::document::view.
Declares mongocxx::v1::hint.
Declares mongocxx::v1::read_concern.
Declares mongocxx::v1::read_preference.
Provides std::optional-related polyfills for library API usage.
Declares bsoncxx::v1::types::value.
Declares non-owning, read-only entities representing a BSON type value.
Declares mongocxx::v1::write_concern.