MongoDB C++ Driver mongocxx-3.1.1
Loading...
Searching...
No Matches
aggregate.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
20#include <bsoncxx/document/view_or_value.hpp>
21#include <bsoncxx/stdx/optional.hpp>
22#include <mongocxx/read_preference.hpp>
23#include <mongocxx/stdx.hpp>
24
25#include <mongocxx/config/prelude.hpp>
26
27namespace mongocxx {
28MONGOCXX_INLINE_NAMESPACE_BEGIN
29namespace options {
30
34class MONGOCXX_API aggregate {
35 public:
43 aggregate& allow_disk_use(bool allow_disk_use);
44
50 const stdx::optional<bool>& allow_disk_use() const;
51
58 aggregate& batch_size(std::int32_t batch_size);
59
65 const stdx::optional<std::int32_t>& batch_size() const;
66
77
87 const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
88
97 aggregate& max_time(std::chrono::milliseconds max_time);
98
107 const stdx::optional<std::chrono::milliseconds>& max_time() const;
108
120 aggregate& use_cursor(bool use_cursor);
121
127 const stdx::optional<bool>& use_cursor() const;
128
137
145 const stdx::optional<class read_preference>& read_preference() const;
146
152 aggregate& bypass_document_validation(bool bypass_document_validation);
153
159 const stdx::optional<bool>& bypass_document_validation() const;
160
161 private:
162 stdx::optional<bool> _allow_disk_use;
163 stdx::optional<std::int32_t> _batch_size;
164 stdx::optional<bsoncxx::document::view_or_value> _collation;
165 stdx::optional<std::chrono::milliseconds> _max_time;
166 stdx::optional<bool> _use_cursor;
167 stdx::optional<class read_preference> _read_preference;
168 stdx::optional<bool> _bypass_document_validation;
169};
170
171} // namespace options
172MONGOCXX_INLINE_NAMESPACE_END
173} // namespace mongocxx
174
175#include <mongocxx/config/postlude.hpp>
Class representing the optional arguments to a MongoDB aggregation operation.
Definition aggregate.hpp:34
const stdx::optional< bool > & bypass_document_validation() const
The current bypass_document_validation setting.
const stdx::optional< std::int32_t > & batch_size() const
The current batch size setting.
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
const stdx::optional< bool > & allow_disk_use() const
Retrieves the current allow_disk_use setting.
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
aggregate & read_preference(class read_preference rp)
Sets the read_preference for this operation.
aggregate & use_cursor(bool use_cursor)
Sets whether the results of this aggregation should be returned via a cursor.
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
aggregate & allow_disk_use(bool allow_disk_use)
Enables writing to temporary files.
aggregate & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
const stdx::optional< bool > & use_cursor() const
The current use_cursor setting.
aggregate & bypass_document_validation(bool bypass_document_validation)
Sets whether the $out stage should bypass document validation.
aggregate & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
aggregate & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run server-side in milliseconds.
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition read_preference.hpp:57
Top level namespace for the MongoDB C++ driver.
Definition bulk_write.hpp:22