IMongoSearchIndexManagerListAsync Method |
Lists the search indexes.
Namespace:
MongoDB.Driver.Search
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.21.0+5a9c3311e158910b88195f290e6d4b1b2715d2b2
Syntax Task<IAsyncCursor<BsonDocument>> ListAsync(
string name = null,
AggregateOptions aggregateOptions = null,
CancellationToken cancellationToken = null
)
Function ListAsync (
Optional name As String = Nothing,
Optional aggregateOptions As AggregateOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of BsonDocument))
abstract ListAsync :
?name : string *
?aggregateOptions : AggregateOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _name = defaultArg name null
let _aggregateOptions = defaultArg aggregateOptions null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<BsonDocument>>
Parameters
- name (Optional)
- Type: SystemString
Name of the index. - aggregateOptions (Optional)
- Type: MongoDB.DriverAggregateOptions
The aggregate options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorBsonDocument
A Task whose result is a cursor.
See Also