SqlConnection.GetSchemaAsync Método

Definição

Namespace:: Microsoft.Data.SqlClient

Assembly:: Microsoft.Data.SqlClient.dll

Pacote:: Microsoft.Data.SqlClient v7.1.0

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Sobrecargas

Nome	Description
GetSchemaAsync(CancellationToken)	Uma versão assíncrona de , que retorna informações de GetSchema()esquema para a fonte de dados deste SqlConnection. Para obter mais informações sobre esquemas, consulte SQL Server Coleções de Esquemas.
GetSchemaAsync(String, CancellationToken)	Uma versão assíncrona de , que retorna informações de GetSchema(String)esquema para a fonte de dados disso SqlConnection usando a cadeia de caracteres especificada para o nome do esquema.
GetSchemaAsync(String, String[], CancellationToken)	Uma versão assíncrona de , que retorna informações de GetSchema(String, String[])esquema para a fonte de dados disso SqlConnection usando a cadeia de caracteres especificada para o nome do esquema e a matriz de cadeia de caracteres especificada para os valores de restrição.

GetSchemaAsync(CancellationToken)

Uma versão assíncrona de , que retorna informações de GetSchema()esquema para a fonte de dados deste SqlConnection. Para obter mais informações sobre esquemas, consulte SQL Server Coleções de Esquemas.

public System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(System.Threading.CancellationToken cancellationToken = default);

public override System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(System.Threading.CancellationToken cancellationToken = default);

member this.GetSchemaAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

override this.GetSchemaAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

Public Function GetSchemaAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Public Overrides Function GetSchemaAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Parâmetros

cancellationToken: CancellationToken

O token de cancelamento.

Retornos

Task<DataTable>

Uma tarefa que representa a operação assíncrona.

Comentários

Para obter mais informações sobre programação assíncrona no Provedor de Dados do .NET Framework para SQL Server, consulte Programação Assíncrona.

Aplica-se a

GetSchemaAsync(String, CancellationToken)

Uma versão assíncrona de , que retorna informações de GetSchema(String)esquema para a fonte de dados disso SqlConnection usando a cadeia de caracteres especificada para o nome do esquema.

public System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(string collectionName, System.Threading.CancellationToken cancellationToken = default);

public override System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(string collectionName, System.Threading.CancellationToken cancellationToken = default);

member this.GetSchemaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

override this.GetSchemaAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

Public Function GetSchemaAsync (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Public Overrides Function GetSchemaAsync (collectionName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Parâmetros

collectionName: String

Especifica o nome do esquema a ser retornado.

cancellationToken: CancellationToken

O token de cancelamento.

Retornos

Task<DataTable>

Uma tarefa que representa a operação assíncrona.

Exceções

ArgumentException

collectionName é especificado como nulo.

Comentários

Para obter mais informações sobre programação assíncrona no Provedor de Dados do .NET Framework para SQL Server, consulte Programação Assíncrona.

Aplica-se a

GetSchemaAsync(String, String[], CancellationToken)

Uma versão assíncrona de , que retorna informações de GetSchema(String, String[])esquema para a fonte de dados disso SqlConnection usando a cadeia de caracteres especificada para o nome do esquema e a matriz de cadeia de caracteres especificada para os valores de restrição.

public System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(string collectionName, string[] restrictionValues, System.Threading.CancellationToken cancellationToken = default);

public override System.Threading.Tasks.Task<System.Data.DataTable> GetSchemaAsync(string collectionName, string[] restrictionValues, System.Threading.CancellationToken cancellationToken = default);

member this.GetSchemaAsync : string * string[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

override this.GetSchemaAsync : string * string[] * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.Data.DataTable>

Public Function GetSchemaAsync (collectionName As String, restrictionValues As String(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Public Overrides Function GetSchemaAsync (collectionName As String, restrictionValues As String(), Optional cancellationToken As CancellationToken = Nothing) As Task(Of DataTable)

Parâmetros

collectionName: String

Especifica o nome do esquema a ser retornado.

restrictionValues: String[]

Um conjunto de valores de restrição para o esquema solicitado.

cancellationToken: CancellationToken

O token de cancelamento.

Retornos

Task<DataTable>

Uma tarefa que representa a operação assíncrona.

Exceções

ArgumentException

collectionName é especificado como nulo.

Comentários

O restrictionValues parâmetro pode fornecer n profundidade de valores, que são especificados pela coleção de restrições para uma coleção específica. Para definir valores em uma determinada restrição e não definir os valores de outras restrições, você precisa definir as restrições null anteriores e, em seguida, colocar o valor apropriado para a restrição para a qual você gostaria de especificar um valor.

Um exemplo disso é a coleção "Tables". Se a coleção "Tables" tiver três restrições: banco de dados, proprietário e nome da tabela, e você quiser retornar apenas as tabelas associadas ao proprietário "Carl", será necessário passar os seguintes valores: nulo, "Carl". Se um valor de restrição não for passado, os valores padrão serão usados para essa restrição. Esse é o mesmo mapeamento que a passagem null, que é diferente de passar uma cadeia de caracteres vazia para o valor do parâmetro. Nesse caso, a cadeia de caracteres vazia ("") é considerada o valor do parâmetro especificado.

Confira também

GetSchema()

Aplica-se a