MongoDatabaseBaseRenameCollectionAsync Method (String, String, RenameCollectionOptions, CancellationToken) |
Renames the collection.
Namespace:
MongoDB.Driver
Assembly:
MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax public abstract Task RenameCollectionAsync(
string oldName,
string newName,
RenameCollectionOptions options = null,
CancellationToken cancellationToken = default
)
Public MustOverride Function RenameCollectionAsync (
oldName As String,
newName As String,
Optional options As RenameCollectionOptions = Nothing,
Optional cancellationToken As CancellationToken = Nothing
) As Task
abstract RenameCollectionAsync :
oldName : string *
newName : string *
?options : RenameCollectionOptions *
?cancellationToken : CancellationToken
(* Defaults:
let _options = defaultArg options null
let _cancellationToken = defaultArg cancellationToken new CancellationToken()
*)
-> Task
Parameters
- 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:
TaskA task.
Implements
IMongoDatabaseRenameCollectionAsync(String, String, RenameCollectionOptions, CancellationToken)See Also