Click or drag to resize

MongoDatabaseBaseRenameCollectionAsync Method (IClientSessionHandle, String, String, RenameCollectionOptions, CancellationToken)

Renames the collection.

Namespace:  MongoDB.Driver
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.22.0+75246110ed1247226fcc7f8eb2c54ffab745693e
Syntax
public virtual 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.

Implements

IMongoDatabaseRenameCollectionAsync(IClientSessionHandle, String, String, RenameCollectionOptions, CancellationToken)
See Also