IMongoCollectionExtensions.DistinctAsync<TDocument, TField> Method (IMongoCollection<TDocument>, IClientSessionHandle, Expression<Func<TDocument, TField>>, Expression<Func<TDocument, Boolean>>, DistinctOptions, CancellationToken) |
Gets the distinct values for a specified field.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public static Task<IAsyncCursor<TField>> DistinctAsync<TDocument, TField>(
this IMongoCollection<TDocument> collection,
IClientSessionHandle session,
Expression<Func<TDocument, TField>> field,
Expression<Func<TDocument, bool>> filter,
DistinctOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function DistinctAsync(Of TDocument, TField) (
collection As IMongoCollection(Of TDocument),
session As IClientSessionHandle,
field As Expression(Of Func(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))
[<ExtensionAttribute>]
static member DistinctAsync :
collection : IMongoCollection<'TDocument> *
session : IClientSessionHandle *
field : Expression<Func<'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.Driver.IMongoCollection<TDocument>
The collection. - session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - field
- Type: System.Linq.Expressions.Expression<Func<TDocument, TField>>
The field. - filter
- Type: System.Linq.Expressions.Expression<Func<TDocument, Boolean>>
The filter. - options (Optional)
- Type: MongoDB.Driver.DistinctOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Type Parameters
- TDocument
- The type of the document.
- TField
- The type of the result.
Return Value
Type:
Task<IAsyncCursor<TField>>
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
IMongoCollection<TDocument>. 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