MongoDB C++ Driver  mongocxx-3.0.0
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.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 
27 namespace mongocxx {
28 MONGOCXX_INLINE_NAMESPACE_BEGIN
29 namespace options {
30 
34 class MONGOCXX_API aggregate {
35  public:
43  void allow_disk_use(bool allow_disk_use);
44 
50  const stdx::optional<bool>& allow_disk_use() const;
51 
58  void batch_size(std::int32_t batch_size);
59 
65  const stdx::optional<std::int32_t>& batch_size() const;
66 
75  void max_time(std::chrono::milliseconds max_time);
76 
85  const stdx::optional<std::chrono::milliseconds>& max_time() const;
86 
98  void use_cursor(bool use_cursor);
99 
105  const stdx::optional<bool>& use_cursor() const;
106 
114  void read_preference(class read_preference rp);
115 
123  const stdx::optional<class read_preference>& read_preference() const;
124 
130  void bypass_document_validation(bool bypass_document_validation);
131 
137  const stdx::optional<bool>& bypass_document_validation() const;
138 
139  private:
140  stdx::optional<bool> _allow_disk_use;
141  stdx::optional<std::int32_t> _batch_size;
142  stdx::optional<std::chrono::milliseconds> _max_time;
143  stdx::optional<bool> _use_cursor;
144  stdx::optional<class read_preference> _read_preference;
145  stdx::optional<bool> _bypass_document_validation;
146 };
147 
148 } // namespace options
149 MONGOCXX_INLINE_NAMESPACE_END
150 } // namespace mongocxx
151 
152 #include <mongocxx/config/postlude.hpp>
Definition: bulk_write.hpp:22
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:54
Class representing the optional arguments to a MongoDB aggregation operation.
Definition: aggregate.hpp:34