PipelineDefinitionBuilderOfTypeTInput, TIntermediate, TOutput Method

Appends a $match stage to the pipeline to select documents of a certain type.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2

Syntax

Copy

public static PipelineDefinition<TInput, TOutput> OfType<TInput, TIntermediate, TOutput>(
	this PipelineDefinition<TInput, TIntermediate> pipeline,
	IBsonSerializer<TOutput> outputSerializer = null
)
where TOutput : TIntermediate

<ExtensionAttribute>
Public Shared Function OfType(Of TInput, TIntermediate, TOutput As TIntermediate) ( 
	pipeline As PipelineDefinition(Of TInput, TIntermediate),
	Optional outputSerializer As IBsonSerializer(Of TOutput) = Nothing
) As PipelineDefinition(Of TInput, TOutput)

[<ExtensionAttribute>]
static member OfType : 
        pipeline : PipelineDefinition<'TInput, 'TIntermediate> * 
        ?outputSerializer : IBsonSerializer<'TOutput> 
(* Defaults:
        let _outputSerializer = defaultArg outputSerializer null
*)
-> PipelineDefinition<'TInput, 'TOutput>  when 'TOutput : 'TIntermediate

Parameters

pipeline: Type: MongoDB.DriverPipelineDefinitionTInput, TIntermediate
The pipeline.
outputSerializer (Optional): Type: MongoDB.Bson.SerializationIBsonSerializerTOutput
The output serializer.

Type Parameters

TInput: The type of the input documents.
TIntermediate: The type of the intermediate documents.
TOutput: The type of the output documents.

Return Value

Type: PipelineDefinitionTInput, TOutput
A new pipeline with an additional stage.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type PipelineDefinitionTInput, TIntermediate. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
NotSupportedException

Reference

PipelineDefinitionBuilder Class