DbConnection.ChangeDatabaseAsync(String, CancellationToken) Metoda

Definicja

Przestrzeń nazw:

System.Data.Common

Zestaw:

System.Data.Common.dll

Źródło:

DbConnection.cs

Asynchronicznie zmienia bieżącą bazę danych dla otwartego połączenia.

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

Parametry

databaseName

String

Nazwa bazy danych używanej przez połączenie.

cancellationToken

CancellationToken

Opcjonalny token umożliwiający anulowanie operacji asynchronicznej. Wartość domyślna to None.

Zwraca

Task

Zadanie reprezentujące operację asynchroniczną.

Wyjątki

OperationCanceledException

Token anulowania został anulowany. Ten wyjątek jest przechowywany w zwracanym zadaniu.

Uwagi

Wartość podana w parametrze databaseName musi być prawidłową nazwą bazy danych dla bieżącego wystąpienia.

Domyślna implementacja tej metody asynchronicznej deleguje do synchronicznego odpowiednika i zwraca ukończony Taskelement , co potencjalnie blokuje wątek wywołujący.

Dostawcy danych, którzy obsługują programowanie asynchroniczne , powinni zastąpić domyślną implementację przy użyciu asynchronicznych operacji we/wy.

Ta metoda jest przechowywana w zadaniu, które zwraca wszystkie wyjątki nieużytowe, które może zgłosić synchroniczna odpowiednik metody. Jeśli wyjątek jest przechowywany w zwracanym zadaniu, ten wyjątek zostanie zgłoszony podczas oczekiwania zadania. Wyjątki użycia, takie jak ArgumentException, są nadal zgłaszane synchronicznie. W przypadku przechowywanych wyjątków zobacz wyjątki zgłoszone przez ChangeDatabase(String)usługę .