IMongoCollectionExtensions.Distinct<TDocument, TField> Method (IMongoCollection<TDocument>, Expression<Func<TDocument, TField>>, FilterDefinition<TDocument>, DistinctOptions, CancellationToken) |
Gets the distinct values for a specified field.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.10.0+569905ff5e778c38ea19d9d0392496a83e1704ed
Syntaxpublic static IAsyncCursor<TField> Distinct<TDocument, TField>(
this IMongoCollection<TDocument> collection,
Expression<Func<TDocument, TField>> field,
FilterDefinition<TDocument> filter,
DistinctOptions options = null,
CancellationToken cancellationToken = null
)
<ExtensionAttribute>
Public Shared Function Distinct(Of TDocument, TField) (
collection As IMongoCollection(Of TDocument),
field As Expression(Of Func(Of TDocument, TField)),
filter As FilterDefinition(Of TDocument),
Optional options As DistinctOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of TField)
[<ExtensionAttribute>]
static member Distinct :
collection : IMongoCollection<'TDocument> *
field : Expression<Func<'TDocument, 'TField>> *
filter : FilterDefinition<'TDocument> *
?options : DistinctOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> IAsyncCursor<'TField>
Parameters
- collection
- Type: MongoDB.Driver.IMongoCollection<TDocument>
The collection. - field
- Type: System.Linq.Expressions.Expression<Func<TDocument, TField>>
The field. - filter
- Type: MongoDB.Driver.FilterDefinition<TDocument>
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:
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