MongoClientBaseListDatabaseNamesAsync Method (IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken) |
Returns the names of the databases on the server.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntax public virtual Task<IAsyncCursor<string>> ListDatabaseNamesAsync(
IClientSessionHandle session,
ListDatabaseNamesOptions options,
CancellationToken cancellationToken = default
)
Public Overridable Function ListDatabaseNamesAsync (
session As IClientSessionHandle,
options As ListDatabaseNamesOptions,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of String))
abstract ListDatabaseNamesAsync :
session : IClientSessionHandle *
options : ListDatabaseNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<string>>
override ListDatabaseNamesAsync :
session : IClientSessionHandle *
options : ListDatabaseNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<string>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options
- Type: MongoDB.DriverListDatabaseNamesOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorStringThe database names.
Implements
IMongoClientListDatabaseNamesAsync(IClientSessionHandle, ListDatabaseNamesOptions, CancellationToken)See Also