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 <cstdint>
#include <memory>
#include <string>
 
#include <mongocxx/client-fwd.hpp>
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/pipeline-fwd.hpp>
 
#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 {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() pipeline();
 
    MONGOCXX_ABI_EXPORT_CDECL() pipeline(pipeline&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) operator=(pipeline&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~pipeline();
 
    pipeline(const pipeline&) = delete;
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) operator=(const pipeline&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    add_fields(bsoncxx::v_noabi::document::view_or_value fields_to_add);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    bucket(bsoncxx::v_noabi::document::view_or_value bucket_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    bucket_auto(bsoncxx::v_noabi::document::view_or_value bucket_auto_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    coll_stats(bsoncxx::v_noabi::document::view_or_value coll_stats_args =
                   bsoncxx::v_noabi::document::view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) count(std::string field);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    current_op(bsoncxx::v_noabi::document::view_or_value current_op_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    facet(bsoncxx::v_noabi::document::view_or_value facet_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    append_stage(bsoncxx::v_noabi::document::view_or_value stage);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    append_stages(bsoncxx::v_noabi::array::view_or_value stages);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    geo_near(bsoncxx::v_noabi::document::view_or_value geo_near_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    graph_lookup(bsoncxx::v_noabi::document::view_or_value graph_lookup_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    group(bsoncxx::v_noabi::document::view_or_value group_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) index_stats();
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) limit(std::int32_t limit);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    list_local_sessions(bsoncxx::v_noabi::document::view_or_value list_local_sessions_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    list_sessions(bsoncxx::v_noabi::document::view_or_value list_sessions_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    lookup(bsoncxx::v_noabi::document::view_or_value lookup_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) match(bsoncxx::v_noabi::document::view_or_value filter);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    merge(bsoncxx::v_noabi::document::view_or_value merge_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) out(std::string collection_name);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    project(bsoncxx::v_noabi::document::view_or_value projection);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    redact(bsoncxx::v_noabi::document::view_or_value restrictions);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    replace_root(bsoncxx::v_noabi::document::view_or_value replace_root_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) sample(std::int32_t size);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) skip(std::int32_t docs_to_skip);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) sort(bsoncxx::v_noabi::document::view_or_value ordering);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    sort_by_count(bsoncxx::v_noabi::document::view_or_value field_expression);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) sort_by_count(std::string field_expression);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&)
    unwind(bsoncxx::v_noabi::document::view_or_value unwind_args);
 
    MONGOCXX_ABI_EXPORT_CDECL(pipeline&) unwind(std::string field_name);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::array::view) view_array() const;
 
   private:
    friend ::mongocxx::v_noabi::client;
    friend ::mongocxx::v_noabi::collection;
    friend ::mongocxx::v_noabi::database;
 
    class impl;
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>