Click or drag to resize

IMongoDatabaseRenameCollectionAsync 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
Task RenameCollectionAsync(
	IClientSessionHandle session,
	string oldName,
	string newName,
	RenameCollectionOptions options = null,
	CancellationToken cancellationToken = default
)

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.
See Also