PipelineDefinitionBuilder Class

Extension methods for adding stages to a pipeline.

Inheritance Hierarchy

SystemObject
MongoDB.DriverPipelineDefinitionBuilder

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.13.1-v2-13-x1+a7f8afe27855f38f4f72157d11ba2ae73895502e

Syntax

Copy

public static class PipelineDefinitionBuilder

<ExtensionAttribute>
Public NotInheritable Class PipelineDefinitionBuilder

[<AbstractClassAttribute>]
[<SealedAttribute>]
[<ExtensionAttribute>]
type PipelineDefinitionBuilder =  class end

The PipelineDefinitionBuilder type exposes the following members.

Methods

	Name	Description
	AppendStageTInput, TIntermediate, TOutput	Appends a stage to the pipeline.
	AsTInput, TIntermediate, TOutput	Changes the output type of the pipeline.
	BucketTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, IEnumerableTValue, AggregateBucketOptionsTValue)	Appends a $bucket stage to the pipeline.
	BucketTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, IEnumerableTValue, AggregateBucketOptionsTValue, ExpressionTranslationOptions)	Appends a $bucket stage to the pipeline.
	BucketTInput, TIntermediate, TValue, TOutput(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, IEnumerableTValue, ProjectionDefinitionTIntermediate, TOutput, AggregateBucketOptionsTValue)	Appends a $bucket stage to the pipeline.
	BucketTInput, TIntermediate, TValue, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, IEnumerableTValue, ExpressionFuncIGroupingTValue, TIntermediate, TOutput, AggregateBucketOptionsTValue, ExpressionTranslationOptions)	Appends a $bucket stage to the pipeline.
	BucketAutoTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, Int32, AggregateBucketAutoOptions)	Appends a $bucketAuto stage to the pipeline.
	BucketAutoTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, Int32, AggregateBucketAutoOptions, ExpressionTranslationOptions)	Appends a $bucketAuto stage to the pipeline.
	BucketAutoTInput, TIntermediate, TValue, TOutput(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue, Int32, ProjectionDefinitionTIntermediate, TOutput, AggregateBucketAutoOptions)	Appends a $bucketAuto stage to the pipeline.
	BucketAutoTInput, TIntermediate, TValue, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, Int32, ExpressionFuncIGroupingTValue, TIntermediate, TOutput, AggregateBucketAutoOptions, ExpressionTranslationOptions)	Appends a $bucketAuto stage to the pipeline.
	ChangeStreamTInput, TIntermediate	Appends a $changeStream stage to the pipeline. Normally you would prefer to use the Watch method of IMongoCollectionTDocument. Only use this method if subsequent stages project away the resume token (the _id) or you don't want the resulting cursor to automatically resume.
	CountTInput, TIntermediate	Appends a $count stage to the pipeline.
	FacetTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, AggregateFacetTIntermediate)	Appends a $facet stage to the pipeline.
	FacetTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, IEnumerableAggregateFacetTIntermediate)	Appends a $facet stage to the pipeline.
	FacetTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, AggregateFacetTIntermediate)	Appends a $facet stage to the pipeline.
	FacetTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, IEnumerableAggregateFacetTIntermediate, AggregateFacetOptionsTOutput)	Appends a $facet stage to the pipeline.
	ForTInput	Used to start creating a pipeline for {TInput} documents.
	GraphLookupTInput, TIntermediate, TFrom(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, FieldDefinitionTFrom, BsonValue, FieldDefinitionTFrom, BsonValue, AggregateExpressionDefinitionTIntermediate, BsonValue, FieldDefinitionBsonDocument, IEnumerableBsonDocument, FieldDefinitionBsonDocument, Int32)	Appends a $graphLookup stage to the pipeline.
	GraphLookupTInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTIntermediate, TStartWith, FieldDefinitionTOutput, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TOutput)	Appends a $graphLookup stage to the pipeline.
	GraphLookupTInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, ExpressionFuncTFrom, TConnectFrom, ExpressionFuncTFrom, TConnectTo, ExpressionFuncTIntermediate, TStartWith, ExpressionFuncTOutput, TAs, AggregateGraphLookupOptionsTFrom, TFrom, TOutput, ExpressionTranslationOptions)	Appends a $graphLookup stage to the pipeline.
	GraphLookupTInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, FieldDefinitionTFrom, TConnectFrom, FieldDefinitionTFrom, TConnectTo, AggregateExpressionDefinitionTIntermediate, TStartWith, FieldDefinitionTOutput, TAs, FieldDefinitionTAsElement, Int32, AggregateGraphLookupOptionsTFrom, TAsElement, TOutput)	Appends a $graphLookup stage to the pipeline.
	GraphLookupTInput, TIntermediate, TFrom, TConnectFrom, TConnectTo, TStartWith, TAsElement, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTFrom, ExpressionFuncTFrom, TConnectFrom, ExpressionFuncTFrom, TConnectTo, ExpressionFuncTIntermediate, TStartWith, ExpressionFuncTOutput, TAs, ExpressionFuncTAsElement, Int32, AggregateGraphLookupOptionsTFrom, TAsElement, TOutput, ExpressionTranslationOptions)	Appends a $graphLookup stage to the pipeline.
	GroupTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, ProjectionDefinitionTIntermediate, BsonDocument)	Appends a group stage to the pipeline.
	GroupTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ProjectionDefinitionTIntermediate, TOutput)	Appends a $group stage to the pipeline.
	GroupTInput, TIntermediate, TKey, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TKey, ExpressionFuncIGroupingTKey, TIntermediate, TOutput, ExpressionTranslationOptions)	Appends a group stage to the pipeline.
	LimitTInput, TOutput	Appends a $limit stage to the pipeline.
	LookupTInput, TIntermediate, TForeignDocument, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTForeignDocument, FieldDefinitionTIntermediate, FieldDefinitionTForeignDocument, FieldDefinitionTOutput, AggregateLookupOptionsTForeignDocument, TOutput)	Appends a $lookup stage to the pipeline.
	LookupTInput, TIntermediate, TForeignDocument, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTForeignDocument, ExpressionFuncTIntermediate, Object, ExpressionFuncTForeignDocument, Object, ExpressionFuncTOutput, Object, AggregateLookupOptionsTForeignDocument, TOutput)	Appends a lookup stage to the pipeline.
	LookupTInput, TIntermediate, TForeignDocument, TAsElement, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTForeignDocument, BsonDocument, PipelineDefinitionTForeignDocument, TAsElement, FieldDefinitionTOutput, TAs, AggregateLookupOptionsTForeignDocument, TOutput)	Appends a $lookup stage to the pipeline.
	LookupTInput, TIntermediate, TForeignDocument, TAsElement, TAs, TOutput(PipelineDefinitionTInput, TIntermediate, IMongoCollectionTForeignDocument, BsonDocument, PipelineDefinitionTForeignDocument, TAsElement, ExpressionFuncTOutput, TAs, AggregateLookupOptionsTForeignDocument, TOutput)	Appends a $lookup stage to the pipeline.
	MatchTInput, TOutput(PipelineDefinitionTInput, TOutput, FilterDefinitionTOutput)	Appends a $match stage to the pipeline.
	MatchTInput, TOutput(PipelineDefinitionTInput, TOutput, ExpressionFuncTOutput, Boolean)	Appends a match stage to the pipeline.
	MergeTInput, TIntermediate, TOutput	Appends a $merge stage to the pipeline.
	OfTypeTInput, TIntermediate, TOutput	Appends a $match stage to the pipeline to select documents of a certain type.
	OutTInput, TOutput	Appends a $out stage to the pipeline.
	ProjectTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, ProjectionDefinitionTIntermediate, BsonDocument)	Appends a project stage to the pipeline.
	ProjectTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ProjectionDefinitionTIntermediate, TOutput)	Appends a $project stage to the pipeline.
	ProjectTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TOutput, ExpressionTranslationOptions)	Appends a project stage to the pipeline.
	ReplaceRootTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TOutput)	Appends a $replaceRoot stage to the pipeline.
	ReplaceRootTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TOutput, ExpressionTranslationOptions)	Appends a $replaceRoot stage to the pipeline.
	ReplaceWithTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TOutput)	Appends a $replaceWith stage to the pipeline.
	ReplaceWithTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TOutput, ExpressionTranslationOptions)	Appends a $replaceWith stage to the pipeline.
	SkipTInput, TOutput	Appends a $skip stage to the pipeline.
	SortTInput, TOutput	Appends a $sort stage to the pipeline.
	SortByCountTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, AggregateExpressionDefinitionTIntermediate, TValue)	Appends a $sortByCount stage to the pipeline.
	SortByCountTInput, TIntermediate, TValue(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, TValue, ExpressionTranslationOptions)	Appends a sortByCount stage to the pipeline.
	UnionWithTInput, TWith, TOutput	Appends a $unionWith stage to the pipeline.
	UnwindTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, FieldDefinitionTIntermediate, AggregateUnwindOptionsBsonDocument)	Appends an unwind stage to the pipeline.
	UnwindTInput, TIntermediate(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, Object, AggregateUnwindOptionsBsonDocument)	Appends an unwind stage to the pipeline.
	UnwindTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, FieldDefinitionTIntermediate, AggregateUnwindOptionsTOutput)	Appends an $unwind stage to the pipeline.
	UnwindTInput, TIntermediate, TOutput(PipelineDefinitionTInput, TIntermediate, ExpressionFuncTIntermediate, Object, AggregateUnwindOptionsTOutput)	Appends an unwind stage to the pipeline.

Top

Reference

MongoDB.Driver Namespace