PipelineDefinitionBuilder.Out(TInput, TOutput) Method

PipelineDefinitionBuilderOutTInput, TOutput Method

Appends a $out stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.4.1

Syntax

public static PipelineDefinition<TInput, TOutput> Out<TInput, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	IMongoCollection<TOutput> outputCollection
)

<ExtensionAttribute>
Public Shared Function Out(Of TInput, TOutput) ( 
	pipeline As PipelineDefinition(Of TInput, TOutput),
	outputCollection As IMongoCollection(Of TOutput)
) As PipelineDefinition(Of TInput, TOutput)

[<ExtensionAttribute>]
static member Out : 
        pipeline : PipelineDefinition<'TInput, 'TOutput> * 
        outputCollection : IMongoCollection<'TOutput> -> PipelineDefinition<'TInput, 'TOutput>

Parameters

pipeline: Type: MongoDB.DriverPipelineDefinitionTInput, TOutput
The pipeline.
outputCollection: Type: MongoDB.DriverIMongoCollectionTOutput
The output collection.

Type Parameters

TInput: The type of the input 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, TOutput. 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

MongoDB.Driver Namespace