MongoDatabaseBaseListCollectionsAsync Method (IClientSessionHandle, ListCollectionsOptions, CancellationToken) |
Lists all the collections in the database.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.17.0+b316340e6cc3a8bfc8638dc31b54fbbfe41bfcb2
Syntax public virtual Task<IAsyncCursor<BsonDocument>> ListCollectionsAsync(
IClientSessionHandle session,
ListCollectionsOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function ListCollectionsAsync (
session As IClientSessionHandle,
Optional options As ListCollectionsOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task(Of IAsyncCursor(Of BsonDocument))
abstract ListCollectionsAsync :
session : IClientSessionHandle *
?options : ListCollectionsOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<BsonDocument>>
override ListCollectionsAsync :
session : IClientSessionHandle *
?options : ListCollectionsOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task<IAsyncCursor<BsonDocument>>
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.DriverListCollectionsOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
TaskIAsyncCursorBsonDocument
A Task whose result is a cursor.
Implements
IMongoDatabaseListCollectionsAsync(IClientSessionHandle, ListCollectionsOptions, CancellationToken)See Also