MongoDatabaseBaseRenameCollectionAsync Method (IClientSessionHandle, String, String, RenameCollectionOptions, CancellationToken) |
Renames the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.15.0+f503bf610759c13f78cff9a3c01e91453185d2ed
Syntax public virtual Task RenameCollectionAsync(
IClientSessionHandle session,
string oldName,
string newName,
RenameCollectionOptions options = null,
CancellationToken cancellationToken = default
)
Public Overridable Function RenameCollectionAsync (
session As IClientSessionHandle,
oldName As String,
newName As String,
Optional options As RenameCollectionOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract RenameCollectionAsync :
session : IClientSessionHandle *
oldName : string *
newName : string *
?options : RenameCollectionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
override RenameCollectionAsync :
session : IClientSessionHandle *
oldName : string *
newName : string *
?options : RenameCollectionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
Parameters
- session
- Type: MongoDB.DriverIClientSessionHandle
The session. - oldName
- Type: SystemString
The old name. - newName
- Type: SystemString
The new name. - options (Optional)
- Type: MongoDB.DriverRenameCollectionOptions
The options. - cancellationToken (Optional)
- Type: System.ThreadingCancellationToken
The cancellation token.
Return Value
Type:
Task
A task.
Implements
IMongoDatabaseRenameCollectionAsync(IClientSessionHandle, String, String, RenameCollectionOptions, CancellationToken)See Also