MongoDB C++ Driver  mongocxx-3.1.0
pipeline.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 <cstdint>
18 #include <string>
19 #include <memory>
20 
21 #include <bsoncxx/array/view.hpp>
22 #include <bsoncxx/document/view.hpp>
23 #include <bsoncxx/document/view_or_value.hpp>
24 
25 #include <mongocxx/config/prelude.hpp>
26 
27 namespace mongocxx {
28 MONGOCXX_INLINE_NAMESPACE_BEGIN
29 
30 class collection;
31 
35 class MONGOCXX_API pipeline {
36  public:
42  pipeline();
43 
47  pipeline(pipeline&&) noexcept;
48 
52  pipeline& operator=(pipeline&&) noexcept;
53 
57  ~pipeline();
58 
69  pipeline& add_fields(bsoncxx::document::view_or_value fields_to_add);
70 
81  pipeline& bucket(bsoncxx::document::view_or_value bucket_args);
82 
94  pipeline& bucket_auto(bsoncxx::document::view_or_value bucket_auto_args);
95 
105  pipeline& coll_stats(
107 
116  pipeline& count(std::string field);
117 
128  pipeline& facet(bsoncxx::document::view_or_value facet_args);
129 
139  pipeline& geo_near(bsoncxx::document::view_or_value geo_near_args);
140 
150  pipeline& graph_lookup(bsoncxx::document::view_or_value graph_lookup_args);
151 
166  pipeline& group(bsoncxx::document::view_or_value group_args);
167 
173  pipeline& index_stats();
174 
183  pipeline& limit(std::int32_t limit);
184 
195  pipeline& lookup(bsoncxx::document::view_or_value lookup_args);
196 
207 
218  pipeline& out(std::string collection_name);
219 
228  pipeline& project(bsoncxx::document::view_or_value projection);
229 
239  pipeline& redact(bsoncxx::document::view_or_value restrictions);
240 
250  pipeline& replace_root(bsoncxx::document::view_or_value replace_root_args);
251 
261  pipeline& sample(std::int32_t size);
262 
272  pipeline& skip(std::int32_t docs_to_skip);
273 
283 
297  pipeline& sort_by_count(bsoncxx::document::view_or_value field_expression);
298 
313  pipeline& sort_by_count(std::string field_expression);
314 
329  pipeline& unwind(bsoncxx::document::view_or_value unwind_args);
330 
345  pipeline& unwind(std::string field_name);
346 
350  bsoncxx::array::view view_array() const;
351 
357  MONGOCXX_DEPRECATED bsoncxx::document::view view() const;
358 
359  private:
360  friend class collection;
361 
362  class MONGOCXX_PRIVATE impl;
363  std::unique_ptr<impl> _impl;
364 };
365 
366 MONGOCXX_INLINE_NAMESPACE_END
367 } // namespace mongocxx
368 
369 #include <mongocxx/config/postlude.hpp>
Definition: bulk_write.hpp:22
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
A read-only, non-owning view of a BSON document.
Definition: view.hpp:33
Class representing a MongoDB aggregation pipeline.
Definition: pipeline.hpp:35
Class representing server side document groupings within a MongoDB database.
Definition: collection.hpp:74