pipeline.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/pipeline-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/pipeline.hpp> // IWYU pragma: export
 
#include <cstdint>
#include <memory> // IWYU pragma: keep: backward compatibility, to be removed.
#include <string>
#include <utility>
 
#include <mongocxx/client-fwd.hpp>     // IWYU pragma: keep: backward compatibility, to be removed.
#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/array/view.hpp>
#include <bsoncxx/array/view_or_value.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {

class pipeline {
   private:
    v1::pipeline _pipeline;
 
   public:
    pipeline() = default;

    pipeline(pipeline&& other) noexcept = default;

    pipeline& operator=(pipeline&& other) noexcept = default;

    ~pipeline() = default;
 
    pipeline(pipeline const& other) = delete;
    pipeline& operator=(pipeline const& other) = delete;

    /* explicit(false) */ pipeline(v1::pipeline pipeline) : _pipeline{std::move(pipeline)} {}

    explicit operator v1::pipeline() && {
        return std::move(_pipeline);
    }

    explicit operator v1::pipeline() const& {
        return _pipeline;
    }

    pipeline& add_fields(bsoncxx::v_noabi::document::view_or_value fields_to_add) {
        _pipeline.add_fields(bsoncxx::v_noabi::to_v1(fields_to_add.view()));
        return *this;
    }

    pipeline& bucket(bsoncxx::v_noabi::document::view_or_value bucket_args) {
        _pipeline.bucket(bsoncxx::v_noabi::to_v1(bucket_args.view()));
        return *this;
    }

    pipeline& bucket_auto(bsoncxx::v_noabi::document::view_or_value bucket_auto_args) {
        _pipeline.bucket_auto(bsoncxx::v_noabi::to_v1(bucket_auto_args.view()));
        return *this;
    }

    pipeline& coll_stats(
        bsoncxx::v_noabi::document::view_or_value coll_stats_args = bsoncxx::v_noabi::document::view{}) {
        _pipeline.coll_stats(bsoncxx::v_noabi::to_v1(coll_stats_args.view()));
        return *this;
    }

    pipeline& count(std::string field) {
        _pipeline.count(field);
        return *this;
    }

    pipeline& current_op(bsoncxx::v_noabi::document::view_or_value current_op_args) {
        _pipeline.current_op(bsoncxx::v_noabi::to_v1(current_op_args.view()));
        return *this;
    }

    pipeline& facet(bsoncxx::v_noabi::document::view_or_value facet_args) {
        _pipeline.facet(bsoncxx::v_noabi::to_v1(facet_args.view()));
        return *this;
    }

    pipeline& append_stage(bsoncxx::v_noabi::document::view_or_value stage) {
        _pipeline.append_stage(bsoncxx::v_noabi::to_v1(stage.view()));
        return *this;
    }

    pipeline& append_stages(bsoncxx::v_noabi::array::view_or_value stages) {
        _pipeline.append_stages(bsoncxx::v_noabi::to_v1(stages.view()));
        return *this;
    }

    pipeline& geo_near(bsoncxx::v_noabi::document::view_or_value geo_near_args) {
        _pipeline.geo_near(bsoncxx::v_noabi::to_v1(geo_near_args.view()));
        return *this;
    }

    pipeline& graph_lookup(bsoncxx::v_noabi::document::view_or_value graph_lookup_args) {
        _pipeline.graph_lookup(bsoncxx::v_noabi::to_v1(graph_lookup_args.view()));
        return *this;
    }

    pipeline& group(bsoncxx::v_noabi::document::view_or_value group_args) {
        _pipeline.group(bsoncxx::v_noabi::to_v1(group_args.view()));
        return *this;
    }

    pipeline& index_stats() {
        _pipeline.index_stats();
        return *this;
    }

    pipeline& limit(std::int32_t limit) {
        _pipeline.limit(limit);
        return *this;
    }

    pipeline& list_local_sessions(bsoncxx::v_noabi::document::view_or_value list_local_sessions_args) {
        _pipeline.list_local_sessions(bsoncxx::v_noabi::to_v1(list_local_sessions_args.view()));
        return *this;
    }

    pipeline& list_sessions(bsoncxx::v_noabi::document::view_or_value list_sessions_args) {
        _pipeline.list_sessions(bsoncxx::v_noabi::to_v1(list_sessions_args.view()));
        return *this;
    }

    pipeline& lookup(bsoncxx::v_noabi::document::view_or_value lookup_args) {
        _pipeline.lookup(bsoncxx::v_noabi::to_v1(lookup_args.view()));
        return *this;
    }

    pipeline& match(bsoncxx::v_noabi::document::view_or_value filter) {
        _pipeline.match(bsoncxx::v_noabi::to_v1(filter.view()));
        return *this;
    }

    pipeline& merge(bsoncxx::v_noabi::document::view_or_value merge_args) {
        _pipeline.merge(bsoncxx::v_noabi::to_v1(merge_args.view()));
        return *this;
    }

    pipeline& out(std::string collection_name) {
        _pipeline.out(collection_name);
        return *this;
    }

    pipeline& project(bsoncxx::v_noabi::document::view_or_value projection) {
        _pipeline.project(bsoncxx::v_noabi::to_v1(projection.view()));
        return *this;
    }

    pipeline& redact(bsoncxx::v_noabi::document::view_or_value restrictions) {
        _pipeline.redact(bsoncxx::v_noabi::to_v1(restrictions.view()));
        return *this;
    }

    pipeline& replace_root(bsoncxx::v_noabi::document::view_or_value replace_root_args) {
        _pipeline.replace_root(bsoncxx::v_noabi::to_v1(replace_root_args.view()));
        return *this;
    }

    pipeline& sample(std::int32_t size) {
        _pipeline.sample(size);
        return *this;
    }

    pipeline& skip(std::int32_t docs_to_skip) {
        _pipeline.skip(docs_to_skip);
        return *this;
    }

    pipeline& sort(bsoncxx::v_noabi::document::view_or_value ordering) {
        _pipeline.sort(bsoncxx::v_noabi::to_v1(ordering.view()));
        return *this;
    }

    pipeline& sort_by_count(bsoncxx::v_noabi::document::view_or_value field_expression) {
        _pipeline.sort_by_count(bsoncxx::v_noabi::to_v1(field_expression.view()));
        return *this;
    }

    pipeline& sort_by_count(std::string field_expression) {
        _pipeline.sort_by_count(field_expression);
        return *this;
    }

    pipeline& unwind(bsoncxx::v_noabi::document::view_or_value unwind_args) {
        _pipeline.unwind(bsoncxx::v_noabi::to_v1(unwind_args.view()));
        return *this;
    }

    pipeline& unwind(std::string field_name) {
        _pipeline.unwind(field_name);
        return *this;
    }

    bsoncxx::v_noabi::array::view view_array() const {
        return _pipeline.view_array();
    }
 
    class internal;
};
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>