SqlConnection.GetSchemaAsync 方法

定义

命名空间:: Microsoft.Data.SqlClient

程序集:: Microsoft.Data.SqlClient.dll

程序包:: Microsoft.Data.SqlClient v7.1.0

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

重载

名称	说明
GetSchemaAsync(CancellationToken)	异步版本的 GetSchema()，它返回此 SqlConnection数据源的架构信息。有关架构的详细信息，请参阅SQL Server架构集合。
GetSchemaAsync(String, CancellationToken)	一个异步版本 GetSchema(String)，它使用架构名称的指定字符串返回此 SqlConnection 数据源的架构信息。
GetSchemaAsync(String, String[], CancellationToken)	一个异步版本 GetSchema(String, String[])，它使用架构名称的指定字符串和限制值的指定字符串数组返回此 SqlConnection 数据源的架构信息。

GetSchemaAsync(CancellationToken)

异步版本的 GetSchema()，它返回此 SqlConnection数据源的架构信息。有关架构的详细信息，请参阅SQL Server架构集合。

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)

参数

cancellationToken: CancellationToken

取消令牌。

Task<DataTable>

表示异步操作的任务。

注解

有关 .NET Framework Data Provider 中用于SQL Server的异步编程的详细信息，请参阅 Asynchronous Programming。

适用于

GetSchemaAsync(String, CancellationToken)

一个异步版本 GetSchema(String)，它使用架构名称的指定字符串返回此 SqlConnection 数据源的架构信息。

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)

参数

collectionName: String

指定要返回的架构的名称。

cancellationToken: CancellationToken

取消令牌。

Task<DataTable>

表示异步操作的任务。

例外

ArgumentException

collectionName 指定为 null。

注解

有关 .NET Framework Data Provider 中用于SQL Server的异步编程的详细信息，请参阅 Asynchronous Programming。

适用于

GetSchemaAsync(String, String[], CancellationToken)

一个异步版本 GetSchema(String, String[])，它使用架构名称的指定字符串和限制值的指定字符串数组返回此 SqlConnection 数据源的架构信息。

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)

参数

collectionName: String

指定要返回的架构的名称。

restrictionValues: String[]

所请求架构的一组限制值。

cancellationToken: CancellationToken

取消令牌。

Task<DataTable>

表示异步操作的任务。

例外

ArgumentException

collectionName 指定为 null。

注解

该 restrictionValues 参数可以提供由特定集合的限制集合指定的 值的 n 深度。若要对给定限制设置值，而不设置其他限制的值，需要将上述限制 null 设置为，然后将相应的值放入要为其指定值的限制中。

例如，“Tables”集合。如果“Tables”集合有三个限制，即数据库、所有者和表名，并且想要仅返回与所有者“Carl”关联的表，则需要传入以下值：null、“Carl”。如果未传入限制值，则默认值用于该限制。这与传入 null的映射相同，这与传入参数值的空字符串不同。在这种情况下，空字符串（“”）被视为指定参数的值。

另请参阅

GetSchema()

适用于