MongoDB C++ Driver  mongocxx-3.6.2
All Classes Namespaces Functions Typedefs Enumerations Enumerator Friends Pages
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/builder/basic/document.hpp>
21 #include <bsoncxx/document/view_or_value.hpp>
22 #include <bsoncxx/stdx/optional.hpp>
23 #include <mongocxx/hint.hpp>
24 #include <mongocxx/read_concern.hpp>
25 #include <mongocxx/read_preference.hpp>
26 #include <mongocxx/stdx.hpp>
27 #include <mongocxx/write_concern.hpp>
28 
29 #include <mongocxx/config/prelude.hpp>
30 
31 namespace mongocxx {
32 MONGOCXX_INLINE_NAMESPACE_BEGIN
33 namespace options {
34 
38 class MONGOCXX_API aggregate {
39  public:
53  aggregate& allow_disk_use(bool allow_disk_use);
54 
62  const stdx::optional<bool>& allow_disk_use() const;
63 
76  aggregate& batch_size(std::int32_t batch_size);
77 
85  const stdx::optional<std::int32_t>& batch_size() const;
86 
100 
109  const stdx::optional<bsoncxx::document::view_or_value>& collation() const;
110 
123  aggregate& max_time(std::chrono::milliseconds max_time);
124 
133  const stdx::optional<std::chrono::milliseconds>& max_time() const;
134 
147 
155  const stdx::optional<class read_preference>& read_preference() const;
156 
166  aggregate& bypass_document_validation(bool bypass_document_validation);
167 
175  const stdx::optional<bool>& bypass_document_validation() const;
176 
192  aggregate& hint(class hint index_hint);
193 
201  const stdx::optional<class hint>& hint() const;
202 
218 
228  const stdx::optional<class write_concern>& write_concern() const;
229 
243 
253  const stdx::optional<class read_concern>& read_concern() const;
254 
255  private:
256  friend class ::mongocxx::database;
257  friend class ::mongocxx::collection;
258 
259  void append(bsoncxx::builder::basic::document& builder) const;
260 
261  stdx::optional<bool> _allow_disk_use;
262  stdx::optional<std::int32_t> _batch_size;
263  stdx::optional<bsoncxx::document::view_or_value> _collation;
264  stdx::optional<std::chrono::milliseconds> _max_time;
265  stdx::optional<class read_preference> _read_preference;
266  stdx::optional<bool> _bypass_document_validation;
267  stdx::optional<class hint> _hint;
268  stdx::optional<class write_concern> _write_concern;
269  stdx::optional<class read_concern> _read_concern;
270 };
271 
272 } // namespace options
273 MONGOCXX_INLINE_NAMESPACE_END
274 } // namespace mongocxx
275 
276 #include <mongocxx/config/postlude.hpp>
mongocxx
Top level namespace for the MongoDB C++ driver.
Definition: bulk_write.hpp:24
mongocxx::options::aggregate::allow_disk_use
const stdx::optional< bool > & allow_disk_use() const
Retrieves the current allow_disk_use setting.
mongocxx::options::aggregate::read_concern
aggregate & read_concern(class read_concern read_concern)
Sets the read concern to use for this operation.
bsoncxx::view_or_value
Class representing a view-or-value variant type.
Definition: view_or_value.hpp:30
mongocxx::options::aggregate
Class representing the optional arguments to a MongoDB aggregation operation.
Definition: aggregate.hpp:38
mongocxx::options::aggregate::write_concern
aggregate & write_concern(class write_concern write_concern)
Sets the write concern to use for this operation.
mongocxx::write_concern
Class representing the server-side requirement for reporting the success of a write operation.
Definition: write_concern.hpp:56
mongocxx::options::aggregate::write_concern
const stdx::optional< class write_concern > & write_concern() const
Gets the current write concern.
mongocxx::options::aggregate::max_time
const stdx::optional< std::chrono::milliseconds > & max_time() const
The current max_time setting.
mongocxx::options::aggregate::max_time
aggregate & max_time(std::chrono::milliseconds max_time)
Sets the maximum amount of time for this operation to run server-side in milliseconds.
mongocxx::read_concern
A class to represent the read concern.
Definition: read_concern.hpp:54
mongocxx::options::aggregate::read_preference
aggregate & read_preference(class read_preference rp)
Sets the read_preference for this operation.
mongocxx::read_preference
Class representing a preference for how the driver routes read operations to members of a replica set...
Definition: read_preference.hpp:62
mongocxx::options::aggregate::collation
aggregate & collation(bsoncxx::document::view_or_value collation)
Sets the collation for this operation.
mongocxx::options::aggregate::bypass_document_validation
const stdx::optional< bool > & bypass_document_validation() const
The current bypass_document_validation setting.
mongocxx::options::aggregate::allow_disk_use
aggregate & allow_disk_use(bool allow_disk_use)
Enables writing to temporary files.
mongocxx::hint
Class representing a hint to be passed to a database operation.
Definition: hint.hpp:32
mongocxx::options::aggregate::hint
const stdx::optional< class hint > & hint() const
Gets the current hint.
mongocxx::options::aggregate::read_concern
const stdx::optional< class read_concern > & read_concern() const
Gets the current read concern.
mongocxx::options::aggregate::batch_size
const stdx::optional< std::int32_t > & batch_size() const
The current batch size setting.
mongocxx::options::aggregate::read_preference
const stdx::optional< class read_preference > & read_preference() const
The current read_preference for this operation.
bsoncxx::builder::basic::document
A traditional builder-style interface for constructing a BSON document.
Definition: document.hpp:37
mongocxx::options::aggregate::collation
const stdx::optional< bsoncxx::document::view_or_value > & collation() const
Retrieves the current collation for this operation.
mongocxx::options::aggregate::hint
aggregate & hint(class hint index_hint)
Sets the index to use for this operation.
mongocxx::options::aggregate::batch_size
aggregate & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
mongocxx::options::aggregate::bypass_document_validation
aggregate & bypass_document_validation(bool bypass_document_validation)
Sets whether the $out stage should bypass document validation.