MongoClientListDatabasesAsync Method (IClientSessionHandle, ListDatabasesOptions, CancellationToken) |
Lists the databases on the server.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public override sealed Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(
IClientSessionHandle session,
ListDatabasesOptions options,
CancellationToken cancellationToken = default
)
Public Overrides NotOverridable Function ListDatabasesAsync (
session As IClientSessionHandle,
options As ListDatabasesOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of BsonDocument))
abstract ListDatabasesAsync :
session : IClientSessionHandle *
options : ListDatabasesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<BsonDocument>>
override ListDatabasesAsync :
session : IClientSessionHandle *
options : ListDatabasesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<BsonDocument>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options
- Type: MongoDB.DriverListDatabasesOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorBsonDocument
A Task whose result is a cursor.
Implements
IMongoClientListDatabasesAsync(IClientSessionHandle, ListDatabasesOptions, CancellationToken)See Also