DbConnection.ChangeDatabaseAsync(String, CancellationToken) Método

Definición

Espacio de nombres:

System.Data.Common

Ensamblado:

System.Data.Common.dll

Source:

DbConnection.cs

Cambia de forma asincrónica la base de datos actual de una conexión abierta.

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

Parámetros

databaseName

String

Nombre de la base de datos que va a utilizar la conexión.

cancellationToken

CancellationToken

Token opcional para cancelar la operación asincrónica. El valor predeterminado es None.

Devoluciones

Task

Tarea que representa la operación asincrónica.

Excepciones

OperationCanceledException

Se canceló el token de cancelación. Esta excepción se almacena en la tarea devuelta.

Comentarios

El valor proporcionado en el databaseName parámetro debe ser un nombre de base de datos válido para la instancia actual.

La implementación predeterminada de este método asincrónico delega a su homólogo sincrónico y devuelve un objeto completado Task, lo que podría bloquear el subproceso que realiza la llamada.

Los proveedores de datos que admiten programación asincrónica deben invalidar la implementación predeterminada mediante operaciones de E/S asincrónicas.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, se producirá esa excepción cuando se espere la tarea. Las excepciones de uso, como ArgumentException, se siguen iniciando de forma sincrónica. Para ver las excepciones almacenadas, consulte las excepciones producidas por ChangeDatabase(String).