DbConnection.ChangeDatabaseAsync(String, CancellationToken) メソッド

定義

開いている接続の現在のデータベースを非同期に変更します。Asynchronously changes the current database for an open connection.

public virtual System.Threading.Tasks.Task ChangeDatabaseAsync (string databaseName, System.Threading.CancellationToken cancellationToken = default);
abstract member ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
override this.ChangeDatabaseAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task
Public Overridable Function ChangeDatabaseAsync (databaseName As String, Optional cancellationToken As CancellationToken = Nothing) As Task

パラメーター

databaseName
String

使用する接続のデータベースの名前。The name of the database for the connection to use.

cancellationToken
CancellationToken

非同期操作を取り消すオプションのトークン。An optional token to cancel the asynchronous operation. 既定値は None です。The default value is None.

戻り値

Task

非同期操作を表すタスク。A task representing the asynchronous operation.

注釈

パラメーターに指定する値は、 databaseName 現在のインスタンスの有効なデータベース名である必要があります。The value supplied in the databaseName parameter must be a valid database name for the current instance.

この非同期メソッドの既定の実装は、対応する同期メソッドにデリゲートし、完了したを返します。これは、 Task 呼び出し元のスレッドをブロックする可能性があります。The default implementation of this asynchronous method delegates to its synchronous counterpart and returns a completed Task, potentially blocking the calling thread.

非同期プログラミングをサポートするデータプロバイダーは、非同期 i/o 操作を使用して既定の実装をオーバーライドする必要があります。Data providers that support asynchronous programming should override the default implementation using asynchronous I/O operations.

適用対象