PipelineDefinitionBuilder.Sort<TInput, TOutput> Method

Appends a $sort stage to the pipeline.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.14.0+2b37a1fe1cbdbe1a020b52b77f1197b6d77575e7

Syntax

Copy

public static PipelineDefinition<TInput, TOutput> Sort<TInput, TOutput>(
	this PipelineDefinition<TInput, TOutput> pipeline,
	SortDefinition<TOutput> sort
)

<ExtensionAttribute>
Public Shared Function Sort(Of TInput, TOutput) ( 
	pipeline As PipelineDefinition(Of TInput, TOutput),
	sort As SortDefinition(Of TOutput)
) As PipelineDefinition(Of TInput, TOutput)

[<ExtensionAttribute>]
static member Sort : 
        pipeline : PipelineDefinition<'TInput, 'TOutput> * 
        sort : SortDefinition<'TOutput> -> PipelineDefinition<'TInput, 'TOutput>

Parameters

pipeline: Type: MongoDB.Driver.PipelineDefinition<TInput, TOutput>
The pipeline.
sort: Type: MongoDB.Driver.SortDefinition<TOutput>
The sort definition.

Type Parameters

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

Return Value

Type: PipelineDefinition<TInput, 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 PipelineDefinition<TInput, 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).

Reference

PipelineDefinitionBuilder Class