IMongoCollectionTDocumentDistinctAsyncTField Method (IClientSessionHandle, FieldDefinitionTDocument, TField, FilterDefinitionTDocument, DistinctOptions, CancellationToken) |
Gets the distinct values for a specified field.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.18.0+554c799eb1ec8dd732f16c739387f6664df1ba7a
Syntax Task<IAsyncCursor<TField>> DistinctAsync<TField>(
IClientSessionHandle session,
FieldDefinition<TDocument, TField> field,
FilterDefinition<TDocument> filter,
DistinctOptions options = null,
CancellationToken cancellationToken = default
)
Function DistinctAsync(Of TField) (
session As IClientSessionHandle,
field As FieldDefinition(Of TDocument, TField),
filter As FilterDefinition(Of TDocument),
Optional options As DistinctOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of TField))
abstract DistinctAsync :
session : IClientSessionHandle *
field : FieldDefinition<'TDocument, 'TField> *
filter : FilterDefinition<'TDocument> *
?options : DistinctOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<'TField>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - field
- Type: MongoDB.DriverFieldDefinitionTDocument, TField
The field. - filter
- Type: MongoDB.DriverFilterDefinitionTDocument
The filter. - options (Optional)
- Type: MongoDB.DriverDistinctOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Type Parameters
- TField
- The type of the result.
Return Value
Type:
TaskIAsyncCursorTField
A Task whose result is a cursor.
See Also