Loading...
Searching...
No Matches
aggregate.hpp
Go to the documentation of this file.
// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#include <mongocxx/options/aggregate-fwd.hpp> // IWYU pragma: export
//
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/types/value.hpp>
#include <mongocxx/v1/aggregate_options.hpp> // IWYU pragma: export
#include <chrono>
#include <cstdint>
#include <utility>
#include <mongocxx/collection-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/database-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <bsoncxx/builder/basic/document.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/types/bson_value/view.hpp>
#include <bsoncxx/types/bson_value/view_or_value.hpp>
#include <mongocxx/hint.hpp>
#include <mongocxx/read_concern.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/write_concern.hpp>
#include <mongocxx/config/prelude.hpp>
namespace mongocxx {
namespace v_noabi {
namespace options {
class aggregate {
public:
aggregate() = default;
/* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() aggregate(v1::aggregate_options opts);
explicit operator v1::aggregate_options() const {
using bsoncxx::v_noabi::to_v1;
using mongocxx::v_noabi::to_v1;
v1::aggregate_options ret;
if (_allow_disk_use) {
ret.allow_disk_use(*_allow_disk_use);
}
if (_batch_size) {
ret.batch_size(*_batch_size);
}
if (_collation) {
ret.collation(bsoncxx::v1::document::value{to_v1(_collation->view())});
}
if (_let) {
ret.let(bsoncxx::v1::document::value{to_v1(_let->view())});
}
if (_max_time) {
ret.max_time(*_max_time);
}
if (_read_preference) {
ret.read_preference(to_v1(*_read_preference));
}
if (_bypass_document_validation) {
ret.bypass_document_validation(*_bypass_document_validation);
}
if (_hint) {
ret.hint(to_v1(*_hint));
}
if (_write_concern) {
ret.write_concern(to_v1(*_write_concern));
}
if (_read_concern) {
ret.read_concern(to_v1(*_read_concern));
}
if (_comment) {
ret.comment(bsoncxx::v1::types::value{to_v1(_comment->view())});
}
return ret;
}
aggregate& allow_disk_use(bool allow_disk_use) {
_allow_disk_use = allow_disk_use;
return *this;
}
bsoncxx::v_noabi::stdx::optional<bool> const& allow_disk_use() const {
return _allow_disk_use;
}
aggregate& batch_size(std::int32_t batch_size) {
_batch_size = batch_size;
return *this;
}
bsoncxx::v_noabi::stdx::optional<std::int32_t> const& batch_size() const {
return _batch_size;
}
aggregate& collation(bsoncxx::v_noabi::document::view_or_value collation) {
_collation = std::move(collation);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& collation() const {
return _collation;
}
aggregate& let(bsoncxx::v_noabi::document::view_or_value let) {
_let = std::move(let);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> const& let() const {
return _let;
}
aggregate& max_time(std::chrono::milliseconds max_time) {
_max_time = max_time;
return *this;
}
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> const& max_time() const {
return _max_time;
}
aggregate& read_preference(v_noabi::read_preference rp) {
_read_preference = std::move(rp);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> const& read_preference() const {
return _read_preference;
}
aggregate& bypass_document_validation(bool bypass_document_validation) {
_bypass_document_validation = bypass_document_validation;
return *this;
}
bsoncxx::v_noabi::stdx::optional<bool> const& bypass_document_validation() const {
return _bypass_document_validation;
}
aggregate& hint(v_noabi::hint index_hint) {
_hint = std::move(index_hint);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::hint> const& hint() const {
return _hint;
}
aggregate& write_concern(v_noabi::write_concern write_concern) {
_write_concern = std::move(write_concern);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> const& write_concern() const {
return _write_concern;
}
aggregate& read_concern(v_noabi::read_concern read_concern) {
_read_concern = std::move(read_concern);
return *this;
}
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> const& read_concern() const {
return _read_concern;
}
aggregate& comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment) {
_comment = std::move(comment);
return *this;
}
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> const& comment() const {
return _comment;
}
class internal;
private:
bsoncxx::v_noabi::stdx::optional<bool> _allow_disk_use;
bsoncxx::v_noabi::stdx::optional<std::int32_t> _batch_size;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _collation;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _let;
bsoncxx::v_noabi::stdx::optional<std::chrono::milliseconds> _max_time;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_preference> _read_preference;
bsoncxx::v_noabi::stdx::optional<bool> _bypass_document_validation;
bsoncxx::v_noabi::stdx::optional<v_noabi::hint> _hint;
bsoncxx::v_noabi::stdx::optional<v_noabi::write_concern> _write_concern;
bsoncxx::v_noabi::stdx::optional<v_noabi::read_concern> _read_concern;
bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::types::bson_value::view_or_value> _comment;
};
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
namespace mongocxx {
namespace v_noabi {
inline v_noabi::options::aggregate from_v1(v1::aggregate_options v) {
return {std::move(v)};
}
inline v1::aggregate_options to_v1(v_noabi::options::aggregate const& v) {
return v1::aggregate_options{v};
}
} // namespace v_noabi
} // namespace mongocxx
#include <mongocxx/config/postlude.hpp>
aggregate-fwd.hpp
Declares mongocxx::v_noabi::options::aggregate.
aggregate_options.hpp
Provides mongocxx::v1::aggregate_options.
document.hpp
Provides bsoncxx::v_noabi::builder::basic::document.
bsoncxx::v1::document::value
A BSON document.
Definition value.hpp:44
bsoncxx::v1::stdx::optional
A polyfill for std::optional<T>.
Definition optional.hpp:799
bsoncxx::v1::types::value
A union of BSON type values.
Definition value.hpp:52
mongocxx::options::aggregate::aggregate
aggregate()=default
Default initialization.
mongocxx::v1::aggregate_options
Options for an "aggregate" command.
Definition aggregate_options.hpp:62
mongocxx::v1::aggregate_options::hint
aggregate_options & hint(v1::hint v)
Set the "hint" field.
mongocxx::v1::aggregate_options::write_concern
aggregate_options & write_concern(v1::write_concern v)
Set the "writeConcern" field.
mongocxx::v1::aggregate_options::max_time
aggregate_options & max_time(std::chrono::milliseconds v)
Set the "maxTimeMS" field.
mongocxx::v1::aggregate_options::read_preference
aggregate_options & read_preference(v1::read_preference v)
Set the "readPreference" field.
mongocxx::v1::aggregate_options::comment
aggregate_options & comment(bsoncxx::v1::types::value v)
Set the "comment" field.
mongocxx::v1::aggregate_options::collation
aggregate_options & collation(bsoncxx::v1::document::value v)
Set the "collation" field.
mongocxx::v1::aggregate_options::allow_disk_use
aggregate_options & allow_disk_use(bool v)
Set the "allowDiskUse" field.
mongocxx::v1::aggregate_options::bypass_document_validation
aggregate_options & bypass_document_validation(bool v)
Set the "bypassDocumentValidation" field.
mongocxx::v1::aggregate_options::batch_size
aggregate_options & batch_size(std::int32_t v)
Set the "batchSize" field.
mongocxx::v1::aggregate_options::let
aggregate_options & let(bsoncxx::v1::document::value v)
Set the "let" field.
mongocxx::v1::aggregate_options::read_concern
aggregate_options & read_concern(v1::read_concern v)
Set the "readConcern" field.
mongocxx::v_noabi::hint
The index to "hint" or force a MongoDB server to use when performing a query.
Definition hint.hpp:42
mongocxx::v_noabi::options::aggregate
Used by MongoDB aggregation operations.
Definition aggregate.hpp:54
mongocxx::v_noabi::options::aggregate::let
aggregate & let(bsoncxx::v_noabi::document::view_or_value let)
Sets the variable mapping for this operation.
Definition aggregate.hpp:227
mongocxx::v_noabi::options::aggregate::bypass_document_validation
aggregate & bypass_document_validation(bool bypass_document_validation)
Sets whether the $out stage should bypass document validation.
Definition aggregate.hpp:314
mongocxx::v_noabi::options::aggregate::max_time
bsoncxx::v_noabi::stdx::optional< std::chrono::milliseconds > const & max_time() const
The current max_time setting.
Definition aggregate.hpp:272
mongocxx::v_noabi::options::aggregate::hint
bsoncxx::v_noabi::stdx::optional< v_noabi::hint > const & hint() const
Gets the current hint.
Definition aggregate.hpp:360
mongocxx::v_noabi::options::aggregate::allow_disk_use
bsoncxx::v_noabi::stdx::optional< bool > const & allow_disk_use() const
Retrieves the current allow_disk_use setting.
Definition aggregate.hpp:149
mongocxx::v_noabi::options::aggregate::batch_size
bsoncxx::v_noabi::stdx::optional< std::int32_t > const & batch_size() const
The current batch size setting.
Definition aggregate.hpp:179
mongocxx::v_noabi::options::aggregate::read_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::read_concern > const & read_concern() const
Gets the current read concern.
Definition aggregate.hpp:422
mongocxx::v_noabi::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.
Definition aggregate.hpp:258
mongocxx::v_noabi::options::aggregate::batch_size
aggregate & batch_size(std::int32_t batch_size)
Sets the number of documents to return per batch.
Definition aggregate.hpp:166
mongocxx::v_noabi::options::aggregate::aggregate
aggregate()=default
Default initialization.
mongocxx::v_noabi::options::aggregate::read_preference
bsoncxx::v_noabi::stdx::optional< v_noabi::read_preference > const & read_preference() const
The current read_preference for this operation.
Definition aggregate.hpp:301
mongocxx::v_noabi::options::aggregate::read_preference
aggregate & read_preference(v_noabi::read_preference rp)
Sets the read_preference for this operation.
Definition aggregate.hpp:288
mongocxx::v_noabi::options::aggregate::comment
aggregate & comment(bsoncxx::v_noabi::types::bson_value::view_or_value comment)
Sets the comment to use for this operation.
Definition aggregate.hpp:438
mongocxx::v_noabi::options::aggregate::let
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & let() const
Retrieves the current variable mapping for this operation.
Definition aggregate.hpp:241
mongocxx::v_noabi::options::aggregate::comment
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > const & comment() const
Gets the current comment.
Definition aggregate.hpp:452
mongocxx::v_noabi::options::aggregate::collation
bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > const & collation() const
Retrieves the current collation for this operation.
Definition aggregate.hpp:210
mongocxx::v_noabi::options::aggregate::collation
aggregate & collation(bsoncxx::v_noabi::document::view_or_value collation)
Sets the collation for this operation.
Definition aggregate.hpp:196
mongocxx::v_noabi::options::aggregate::aggregate_options
operator v1::aggregate_options() const
Convert to the mongocxx::v1 equivalent.
Definition aggregate.hpp:69
mongocxx::v_noabi::options::aggregate::write_concern
bsoncxx::v_noabi::stdx::optional< v_noabi::write_concern > const & write_concern() const
Gets the current write concern.
Definition aggregate.hpp:392
mongocxx::v_noabi::options::aggregate::hint
aggregate & hint(v_noabi::hint index_hint)
Sets the index to use for this operation.
Definition aggregate.hpp:347
mongocxx::v_noabi::options::aggregate::write_concern
aggregate & write_concern(v_noabi::write_concern write_concern)
Sets the write concern to use for this operation. Only has an effect if $out is a part of the pipelin...
Definition aggregate.hpp:378
mongocxx::v_noabi::options::aggregate::bypass_document_validation
bsoncxx::v_noabi::stdx::optional< bool > const & bypass_document_validation() const
The current bypass_document_validation setting.
Definition aggregate.hpp:327
mongocxx::v_noabi::options::aggregate::allow_disk_use
aggregate & allow_disk_use(bool allow_disk_use)
Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp s...
Definition aggregate.hpp:136
mongocxx::v_noabi::options::aggregate::read_concern
aggregate & read_concern(v_noabi::read_concern read_concern)
Sets the read concern to use for this operation.
Definition aggregate.hpp:408
mongocxx::v_noabi::read_concern
Controls the consistency and isolation properties of data read from replica sets and sharded clusters...
Definition read_concern.hpp:54
mongocxx::v_noabi::read_preference
Describes how MongoDB clients route read operations to the members of a replica set or sharded cluste...
Definition read_preference.hpp:59
mongocxx::v_noabi::write_concern
The level of acknowledgment requested for write operations to a MongoDB server.
Definition write_concern.hpp:54
view_or_value.hpp
Provides bsoncxx::v_noabi::document::view_or_value.
MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE
#define MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(...)
Equivalent to MONGOCXX_ABI_EXPORT_UNSTABLE with MONGOCXX_ABI_CDECL.
Definition config.hpp:28
postlude.hpp
The mongocxx v_noabi macro guard postlude header.
prelude.hpp
The mongocxx v_noabi macro guard prelude header.
bsoncxx::v_noabi::document::view_or_value
v_noabi::view_or_value< v_noabi::document::view, v_noabi::document::value > view_or_value
Equivalent to v_noabi::view_or_value<v_noabi::document::view, v_noabi::document::value>.
Definition view_or_value.hpp:30
bsoncxx::v_noabi::types::bson_value::view_or_value
v_noabi::view_or_value< view, value > view_or_value
Equivalent to v_noabi::view_or_value<view, value>.
Definition view_or_value.hpp:31
bsoncxx::v_noabi::to_v1
v1::element::view to_v1(v_noabi::array::element const &v)
Convert to the bsoncxx::v1 equivalent of v.
Definition element.hpp:132
mongocxx::v1
Declares entities whose ABI stability is guaranteed for documented symbols.
mongocxx::v_noabi::options
Declares entities representing options to use with various commands.
mongocxx::v_noabi
Declares entities whose ABI stability is NOT guaranteed.
mongocxx::v_noabi::to_v1
v1::bulk_write to_v1(v_noabi::bulk_write v)
Convert to the mongocxx::v1 equivalent of v.
Definition bulk_write.hpp:162
mongocxx::v_noabi::from_v1
v_noabi::bulk_write from_v1(v1::bulk_write v)
Convert to the mongocxx::v_noabi equivalent of v.
Definition bulk_write.hpp:155
mongocxx
The top-level namespace within which all mongocxx library entities are declared.
view_or_value.hpp
Provides bsoncxx::v_noabi::types::bson_value::view_or_value.
value.hpp
Provides bsoncxx::v1::document::value.
value.hpp
Provides bsoncxx::v1::types::value.
view.hpp
Provides bsoncxx::v_noabi::document::view.
optional.hpp
Provides std::optional-related polyfills for library API usage.
view.hpp
Provides bsoncxx::v_noabi::types::bson_value::view.
collection-fwd.hpp
Declares mongocxx::v_noabi::collection.
database-fwd.hpp
Declares mongocxx::v_noabi::database.
hint.hpp
Provides mongocxx::v_noabi::hint.
read_concern.hpp
Provides mongocxx::v_noabi::read_concern.
read_preference.hpp
Provides mongocxx::v_noabi::read_preference.
write_concern.hpp
Provides mongocxx::v_noabi::write_concern.