MongoDatabaseBaseListCollectionNamesAsync Method (IClientSessionHandle, ListCollectionNamesOptions, CancellationToken) |
Lists the names of all the collections in the database.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.8.0+cc573f3e1f48f39162b4b680e921a623e127e8fa
Syntax public virtual Task<IAsyncCursor<string>> ListCollectionNamesAsync(
IClientSessionHandle session,
ListCollectionNamesOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function ListCollectionNamesAsync (
session As IClientSessionHandle,
Optional options As ListCollectionNamesOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of String))
abstract ListCollectionNamesAsync :
session : IClientSessionHandle *
?options : ListCollectionNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<string>>
override ListCollectionNamesAsync :
session : IClientSessionHandle *
?options : ListCollectionNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> Task<IAsyncCursor<string>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverListCollectionNamesOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorStringA Task whose result is a cursor.
Implements
IMongoDatabaseListCollectionNamesAsync(IClientSessionHandle, ListCollectionNamesOptions, CancellationToken)See Also