IMongoCollectionExtensionsDistinctAsyncTDocument, TField Method (IMongoCollectionTDocument, FieldDefinitionTDocument, TField, ExpressionFuncTDocument, Boolean, DistinctOptions, CancellationToken) (original) (raw)

Gets the distinct values for a specified field.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed

Syntax

public static Task<IAsyncCursor> DistinctAsync<TDocument, TField>( this IMongoCollection collection, FieldDefinition<TDocument, TField> field, Expression<Func<TDocument, bool>> filter, DistinctOptions options = null, CancellationToken cancellationToken = null )

Public Shared Function DistinctAsync(Of TDocument, TField) ( collection As IMongoCollection(Of TDocument), field As FieldDefinition(Of TDocument, TField), filter As Expression(Of Func(Of TDocument, Boolean)), Optional options As DistinctOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing ) As Task(Of IAsyncCursor(Of TField))

[] static member DistinctAsync : collection : IMongoCollection<'TDocument> * field : FieldDefinition<'TDocument, 'TField> * filter : Expression<Func<'TDocument, bool>> * ?options : DistinctOptions * ?cancellationToken : CancellationToken (* Defaults: let _options = defaultArg options null let _cancellationToken = defaultArg cancellationToken null *) -> Task<IAsyncCursor<'TField>>

Parameters

collection

Type: MongoDB.DriverIMongoCollectionTDocument
The collection.

field

Type: MongoDB.DriverFieldDefinitionTDocument, TField
The field.

filter

Type: System.Linq.ExpressionsExpressionFuncTDocument, Boolean
The filter.

options (Optional)

Type: MongoDB.DriverDistinctOptions
The options.

cancellationToken (Optional)

Type: System.ThreadingCancellationToken
The cancellation token.

Type Parameters

TDocument

The type of the document.

TField

The type of the result.

Return Value

Type: TaskIAsyncCursorTField
The distinct values for the specified field.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IMongoCollectionTDocument. 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).

See Also

Reference