pipeline.hpp

// Copyright 2014 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 <string>
#include <memory>
 
#include <bsoncxx/array/view.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
MONGOCXX_INLINE_NAMESPACE_BEGIN
 
class collection;
 
class MONGOCXX_API pipeline {
   public:
    pipeline();
 
    pipeline(pipeline&&) noexcept;
 
    pipeline& operator=(pipeline&&) noexcept;
 
    ~pipeline();
 
    pipeline& add_fields(bsoncxx::document::view_or_value fields_to_add);
 
    pipeline& bucket(bsoncxx::document::view_or_value bucket_args);
 
    pipeline& bucket_auto(bsoncxx::document::view_or_value bucket_auto_args);
 
    pipeline& coll_stats(
        bsoncxx::document::view_or_value coll_stats_args = bsoncxx::document::view{});
 
    pipeline& count(std::string field);
 
    pipeline& facet(bsoncxx::document::view_or_value facet_args);
 
    pipeline& geo_near(bsoncxx::document::view_or_value geo_near_args);
 
    pipeline& graph_lookup(bsoncxx::document::view_or_value graph_lookup_args);
 
    pipeline& group(bsoncxx::document::view_or_value group_args);
 
    pipeline& index_stats();
 
    pipeline& limit(std::int32_t limit);
 
    pipeline& lookup(bsoncxx::document::view_or_value lookup_args);
 
    pipeline& match(bsoncxx::document::view_or_value filter);
 
    pipeline& out(std::string collection_name);
 
    pipeline& project(bsoncxx::document::view_or_value projection);
 
    pipeline& redact(bsoncxx::document::view_or_value restrictions);
 
    pipeline& replace_root(bsoncxx::document::view_or_value replace_root_args);
 
    pipeline& sample(std::int32_t size);
 
    pipeline& skip(std::int32_t docs_to_skip);
 
    pipeline& sort(bsoncxx::document::view_or_value ordering);
 
    pipeline& sort_by_count(bsoncxx::document::view_or_value field_expression);
 
    pipeline& sort_by_count(std::string field_expression);
 
    pipeline& unwind(bsoncxx::document::view_or_value unwind_args);
 
    pipeline& unwind(std::string field_name);
 
    bsoncxx::array::view view_array() const;
 
    MONGOCXX_DEPRECATED bsoncxx::document::view view() const;
 
   private:
    friend class collection;
 
    class MONGOCXX_PRIVATE impl;
    std::unique_ptr<impl> _impl;
};
 
MONGOCXX_INLINE_NAMESPACE_END
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>