MongoDB C++ Driver
mongocxx-3.10.2
|
Class representing a MongoDB aggregation pipeline. More...
#include <pipeline.hpp>
Public Member Functions | |
pipeline () | |
Creates a new aggregation pipeline. More... | |
pipeline (pipeline &&) noexcept | |
Move constructs a pipeline. | |
pipeline & | operator= (pipeline &&) noexcept |
Move assigns a pipeline. | |
~pipeline () | |
Destroys a pipeline. | |
pipeline & | add_fields (bsoncxx::v_noabi::document::view_or_value fields_to_add) |
Adds new fields to documents. More... | |
pipeline & | bucket (bsoncxx::v_noabi::document::view_or_value bucket_args) |
Categorizes documents into groups, called buckets, based on a specified expression and bucket boundaries. More... | |
pipeline & | bucket_auto (bsoncxx::v_noabi::document::view_or_value bucket_auto_args) |
Categorizes documents into a specific number of groups, called buckets, based on a specified expression. More... | |
pipeline & | coll_stats (bsoncxx::v_noabi::document::view_or_value coll_stats_args=bsoncxx::v_noabi::document::view{}) |
Returns statistics regarding a collection or view. More... | |
pipeline & | count (std::string field) |
Returns a document containing a count of the number of documents input to the stage. More... | |
pipeline & | current_op (bsoncxx::v_noabi::document::view_or_value current_op_args) |
Returns a stream of documents containing information on active and/or dormant operations as well as inactive sessions that are holding locks as part of a transaction. More... | |
pipeline & | facet (bsoncxx::v_noabi::document::view_or_value facet_args) |
Processes multiple aggregation pipelines within a single stage on the same set of input documents. More... | |
pipeline & | append_stage (bsoncxx::v_noabi::document::view_or_value stage) |
Appends a stage to this pipeline object. More... | |
pipeline & | append_stages (bsoncxx::v_noabi::array::view_or_value stages) |
Appends stages to this pipeline object from the given bson array. More... | |
pipeline & | geo_near (bsoncxx::v_noabi::document::view_or_value geo_near_args) |
Outputs documents in order of nearest to farthest from a specified point. More... | |
pipeline & | graph_lookup (bsoncxx::v_noabi::document::view_or_value graph_lookup_args) |
Performs a recursive search on a collection. More... | |
pipeline & | group (bsoncxx::v_noabi::document::view_or_value group_args) |
Groups documents by some specified expression and outputs to the next stage a document for each distinct grouping. More... | |
pipeline & | index_stats () |
Returns statistics regarding the use of each index for the collection. More... | |
pipeline & | limit (std::int32_t limit) |
Limits the number of documents passed to the next stage in the pipeline. More... | |
pipeline & | list_local_sessions (bsoncxx::v_noabi::document::view_or_value list_local_sessions_args) |
Lists the sessions cached in memory by the mongod or mongos instance. More... | |
pipeline & | list_sessions (bsoncxx::v_noabi::document::view_or_value list_sessions_args) |
Lists all sessions stored in the system.sessions collection in the config database. More... | |
pipeline & | lookup (bsoncxx::v_noabi::document::view_or_value lookup_args) |
Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing. More... | |
pipeline & | match (bsoncxx::v_noabi::document::view_or_value filter) |
Filters the documents. More... | |
pipeline & | merge (bsoncxx::v_noabi::document::view_or_value merge_args) |
Outputs the aggregation results to a collection. More... | |
pipeline & | out (std::string collection_name) |
Takes documents returned by the aggregation pipeline and writes them to a specified collection. More... | |
pipeline & | project (bsoncxx::v_noabi::document::view_or_value projection) |
Projects a subset of the fields in the documents to the next stage of the pipeline. More... | |
pipeline & | redact (bsoncxx::v_noabi::document::view_or_value restrictions) |
Restricts the contents of the documents based on information stored in the documents themselves. More... | |
pipeline & | replace_root (bsoncxx::v_noabi::document::view_or_value replace_root_args) |
Promotes a specified document to the top level and replaces all other fields. More... | |
pipeline & | sample (std::int32_t size) |
Randomly selects the specified number of documents that pass into the stage and passes the remaining documents to the next stage in the pipeline. More... | |
pipeline & | skip (std::int32_t docs_to_skip) |
Skips over the specified number of documents that pass into the stage and passes the remaining documents to the next stage in the pipeline. More... | |
pipeline & | sort (bsoncxx::v_noabi::document::view_or_value ordering) |
Sorts all input documents and returns them to the pipeline in sorted order. More... | |
pipeline & | sort_by_count (bsoncxx::v_noabi::document::view_or_value field_expression) |
Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group. More... | |
pipeline & | sort_by_count (std::string field_expression) |
Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group. More... | |
pipeline & | unwind (bsoncxx::v_noabi::document::view_or_value unwind_args) |
Deconstructs an array field from the input documents to output a document for each element. More... | |
pipeline & | unwind (std::string field_name) |
Deconstructs an array field from the input documents to output a document for each element. More... | |
bsoncxx::v_noabi::array::view | view_array () const |
Class representing a MongoDB aggregation pipeline.
mongocxx::v_noabi::pipeline::pipeline | ( | ) |
Creates a new aggregation pipeline.
pipeline& mongocxx::v_noabi::pipeline::add_fields | ( | bsoncxx::v_noabi::document::view_or_value | fields_to_add | ) |
Adds new fields to documents.
fields_to_add | A document specifying the fields to add. For each field specified in this parameter, a corresponding field will be added to the documents, where the value of the added field is the result of evaluating the specified expression. |
pipeline& mongocxx::v_noabi::pipeline::append_stage | ( | bsoncxx::v_noabi::document::view_or_value | stage | ) |
Appends a stage to this pipeline object.
Use this method to run new pipeline stages that are not yet offered as explicit methods on this class. Pass in a document describing a pipeline stage:
{ "$addFields" : { "field" : 0 }}
stage | A bson document view or value describing a pipeline stage. |
pipeline& mongocxx::v_noabi::pipeline::append_stages | ( | bsoncxx::v_noabi::array::view_or_value | stages | ) |
Appends stages to this pipeline object from the given bson array.
Use this method to run new pipeline stages that are not yet offered as explicit methods on this class. Pass in an array of documents, where each document in the array describes a pipeline stage:
[ { "$addFields" : { "field" : 0 } }, { "$newStage" : ... }, ... ]
stages | A bson array containing documents describing pipeline stages. |
pipeline& mongocxx::v_noabi::pipeline::bucket | ( | bsoncxx::v_noabi::document::view_or_value | bucket_args | ) |
Categorizes documents into groups, called buckets, based on a specified expression and bucket boundaries.
bucket_args | The specification for the bucket operation. The required fields groupBy and boundaries must be included. |
pipeline& mongocxx::v_noabi::pipeline::bucket_auto | ( | bsoncxx::v_noabi::document::view_or_value | bucket_auto_args | ) |
Categorizes documents into a specific number of groups, called buckets, based on a specified expression.
Bucket boundaries are automatically determined in an attempt to evenly distribute the documents into the specified number of buckets.
bucket_auto_args | The specification for the bucket_auto operation. This required fields groupBy and buckets must be included. |
pipeline& mongocxx::v_noabi::pipeline::coll_stats | ( | bsoncxx::v_noabi::document::view_or_value | coll_stats_args = bsoncxx::v_noabi::document::view{} | ) |
Returns statistics regarding a collection or view.
coll_stats_args | The specification for the coll_stats operation. See link above for a list of valid options. |
pipeline& mongocxx::v_noabi::pipeline::count | ( | std::string | field | ) |
Returns a document containing a count of the number of documents input to the stage.
field | Name of the field for the count to be written to. |
pipeline& mongocxx::v_noabi::pipeline::current_op | ( | bsoncxx::v_noabi::document::view_or_value | current_op_args | ) |
Returns a stream of documents containing information on active and/or dormant operations as well as inactive sessions that are holding locks as part of a transaction.
The stage returns a document for each operation or session.
This stage must be used with database aggregate on the 'admin' database.
current_op_args | A document containing the arguments for the current_op operation. |
pipeline& mongocxx::v_noabi::pipeline::facet | ( | bsoncxx::v_noabi::document::view_or_value | facet_args | ) |
Processes multiple aggregation pipelines within a single stage on the same set of input documents.
facet_args | The specification for the facet operation. Each field in the the provided document should specify an aggregation pipeline, as an array. |
pipeline& mongocxx::v_noabi::pipeline::geo_near | ( | bsoncxx::v_noabi::document::view_or_value | geo_near_args | ) |
Outputs documents in order of nearest to farthest from a specified point.
geo_near_args | The specification for the geo_near operation. The required fields near and distanceField must be included. |
pipeline& mongocxx::v_noabi::pipeline::graph_lookup | ( | bsoncxx::v_noabi::document::view_or_value | graph_lookup_args | ) |
Performs a recursive search on a collection.
graph_lookup_args | The specification for the graph_lookup operation. The required fields from , connectFromField , startWith , connectToField , and as must be included. |
pipeline& mongocxx::v_noabi::pipeline::group | ( | bsoncxx::v_noabi::document::view_or_value | group_args | ) |
Groups documents by some specified expression and outputs to the next stage a document for each distinct grouping.
The output documents contain an _id
field which contains the the distinct key for that group. The output documents can also contain computed fields that hold the values of some accumulator expression grouped by the group's _id
field.
group_args | The specification for the group operation. The required field _id must be included. |
pipeline& mongocxx::v_noabi::pipeline::index_stats | ( | ) |
Returns statistics regarding the use of each index for the collection.
pipeline& mongocxx::v_noabi::pipeline::limit | ( | std::int32_t | limit | ) |
Limits the number of documents passed to the next stage in the pipeline.
limit | The number of documents to which output should be limited. |
pipeline& mongocxx::v_noabi::pipeline::list_local_sessions | ( | bsoncxx::v_noabi::document::view_or_value | list_local_sessions_args | ) |
Lists the sessions cached in memory by the mongod or mongos instance.
This option must be used with database aggregate.
list_local_sessions_args | A document containing the arguments for list_local_sessions. |
pipeline& mongocxx::v_noabi::pipeline::list_sessions | ( | bsoncxx::v_noabi::document::view_or_value | list_sessions_args | ) |
Lists all sessions stored in the system.sessions collection in the config database.
These sessions are visible to all members of the MongoDB deployment.
list_sessions_args | A document containing the arguments for list_sessions. |
pipeline& mongocxx::v_noabi::pipeline::lookup | ( | bsoncxx::v_noabi::document::view_or_value | lookup_args | ) |
Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing.
lookup_args | The specification for the lookup operation. The required fields from , localField , foreignField , and as must be included. |
pipeline& mongocxx::v_noabi::pipeline::match | ( | bsoncxx::v_noabi::document::view_or_value | filter | ) |
Filters the documents.
Only the documents that match the condition(s) specified by the filter
will continue to the next pipeline stage.
filter | The filter. |
pipeline& mongocxx::v_noabi::pipeline::merge | ( | bsoncxx::v_noabi::document::view_or_value | merge_args | ) |
Outputs the aggregation results to a collection.
merge_args | The specification for the merge options. Must include an into field that is either a collection name or a subdocument of the form: { db : <db name>, coll : <collection name> }. |
pipeline& mongocxx::v_noabi::pipeline::out | ( | std::string | collection_name | ) |
Takes documents returned by the aggregation pipeline and writes them to a specified collection.
This stage must be the last stage in the pipeline. The out operator lets the aggregation framework return result sets of any size.
collection_name | The name of the collection where the output documents should go. |
pipeline& mongocxx::v_noabi::pipeline::project | ( | bsoncxx::v_noabi::document::view_or_value | projection | ) |
Projects a subset of the fields in the documents to the next stage of the pipeline.
projection | The projection specification. |
pipeline& mongocxx::v_noabi::pipeline::redact | ( | bsoncxx::v_noabi::document::view_or_value | restrictions | ) |
Restricts the contents of the documents based on information stored in the documents themselves.
restrictions | The document restrictions. |
pipeline& mongocxx::v_noabi::pipeline::replace_root | ( | bsoncxx::v_noabi::document::view_or_value | replace_root_args | ) |
Promotes a specified document to the top level and replaces all other fields.
replace_root_args | The specification for the replace_root operation. The required field newRoot must be included. |
pipeline& mongocxx::v_noabi::pipeline::sample | ( | std::int32_t | size | ) |
Randomly selects the specified number of documents that pass into the stage and passes the remaining documents to the next stage in the pipeline.
size | The number of input documents to select. |
pipeline& mongocxx::v_noabi::pipeline::skip | ( | std::int32_t | docs_to_skip | ) |
Skips over the specified number of documents that pass into the stage and passes the remaining documents to the next stage in the pipeline.
docs_to_skip | The number of input documents to skip. |
pipeline& mongocxx::v_noabi::pipeline::sort | ( | bsoncxx::v_noabi::document::view_or_value | ordering | ) |
Sorts all input documents and returns them to the pipeline in sorted order.
ordering | Document specifying the ordering by which the documents are sorted. |
pipeline& mongocxx::v_noabi::pipeline::sort_by_count | ( | bsoncxx::v_noabi::document::view_or_value | field_expression | ) |
Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group.
field_expression | The expression to group by, as an object. The expression can not evaluate to an object. |
pipeline& mongocxx::v_noabi::pipeline::sort_by_count | ( | std::string | field_expression | ) |
Groups incoming documents based on the value of a specified expression, then computes the count of documents in each distinct group.
field_expression | The expression to group by, as a string. To specify a field path, prefix the field path with a dollar sign ($ ). |
pipeline& mongocxx::v_noabi::pipeline::unwind | ( | bsoncxx::v_noabi::document::view_or_value | unwind_args | ) |
Deconstructs an array field from the input documents to output a document for each element.
Each output document is an input document with the value of its array field replaced by an element from the unwound array.
unwind_args | The specification for the unwind operation. The required field path must be included. |
pipeline& mongocxx::v_noabi::pipeline::unwind | ( | std::string | field_name | ) |
Deconstructs an array field from the input documents to output a document for each element.
Each output document is an input document with the value of its array field replaced by an element from the unwound array.
field_name | The name of the field to unwind. |
bsoncxx::v_noabi::array::view mongocxx::v_noabi::pipeline::view_array | ( | ) | const |