MongoDatabaseBaseListCollections Method (IClientSessionHandle, ListCollectionsOptions, CancellationToken) |
Lists all the collections on the server.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.5.0+57.Branch.master.Sha.6a4e00a2d91090c65a9b11364b9ebfdb9c7da076
Syntax public virtual IAsyncCursor<BsonDocument> ListCollections(
IClientSessionHandle session,
ListCollectionsOptions options = null,
CancellationToken cancellationToken = null
)
Public Overridable Function ListCollections (
session As IClientSessionHandle,
Optional options As ListCollectionsOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of BsonDocument)
abstract ListCollections :
session : IClientSessionHandle *
?options : ListCollectionsOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> IAsyncCursor<BsonDocument>
override ListCollections :
session : IClientSessionHandle *
?options : ListCollectionsOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken null
*)
-> 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:
IAsyncCursorBsonDocument
A cursor.
Implements
IMongoDatabaseListCollections(IClientSessionHandle, ListCollectionsOptions, CancellationToken)See Also