DbConnection.ChangeDatabaseAsync(String, CancellationToken) 方法

定义

为打开的连接对象异步更改当前数据库。

public virtual System.Threading.Tasks.Task ChangeDatabaseAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);

参数

databaseName
String

要使用的连接的数据库名称。

cancellationToken
CancellationToken

用于取消异步操作的可选令牌。 默认值为 None

返回

表示异步操作的任务。

例外

取消令牌已取消。 此异常存储在返回的任务中。

注解

参数中 databaseName 提供的值必须是当前实例的有效数据库名称。

此异步方法的默认实现委托给其同步方法,并返回一个已完成 Task的 ,可能会阻止调用线程。

支持 异步编程 的数据提供程序应使用异步 I/O 操作替代默认实现。

此方法存储在任务中,它返回该方法的同步对应项可能引发的所有非使用异常。 如果异常存储在返回的任务中,则在等待任务时将引发该异常。 使用异常(如 ArgumentException)仍会同步引发。 有关存储的异常,请参阅 引发的 ChangeDatabase(String)异常。

适用于

产品 版本
.NET Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Standard 2.1