MongoDatabaseBase.ListCollectionNames 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.16.0+eeafbea0921243a5868b81984e1083a07c1f75bc
Syntaxpublic virtual IAsyncCursor<string> ListCollectionNames(
IClientSessionHandle session,
ListCollectionNamesOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function ListCollectionNames (
session As IClientSessionHandle,
Optional options As ListCollectionNamesOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As IAsyncCursor(Of String)
abstract ListCollectionNames :
session : IClientSessionHandle *
?options : ListCollectionNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncCursor<string>
override ListCollectionNames :
session : IClientSessionHandle *
?options : ListCollectionNamesOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> IAsyncCursor<string>
Parameters
- session
- Type: MongoDB.Driver.IClientSessionHandle
The session. - options (Optional)
- Type: MongoDB.Driver.ListCollectionNamesOptions
The options. - cancellationToken (Optional)
- Type: System.Threading.CancellationToken
The cancellation token.
Return Value
Type:
IAsyncCursor<String>A cursor.
Implements
IMongoDatabase.ListCollectionNames(IClientSessionHandle, ListCollectionNamesOptions, CancellationToken)
See Also