SqlConnection.GetSchemaAsync 方法

定義

命名空間:: Microsoft.Data.SqlClient

組件:: Microsoft.Data.SqlClient.dll

套件:: Microsoft.Data.SqlClient v7.1.0

重要

部分資訊涉及發行前產品，在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊，不做任何明確或隱含的瑕疵擔保。

多載

名稱	Description
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框架Data Provider for SQL Server 非同步程式設計的資訊，請參見非同步程式設計。

適用於

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 指定為空。

備註

欲了解更多關於.NET框架Data Provider for SQL Server 非同步程式設計的資訊，請參見非同步程式設計。

適用於

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 指定為空。

備註

參數 restrictionValues 可提供 n 深度的值，這些深度由特定集合的限制集合指定。為了設定給定限制的值，而非設定其他限制的值，你需要先將前述限制設為， null 然後輸入你想指定值的該限制的適當值。

例如「Tables」集合。如果「Tables」集合有三個限制——資料庫、擁有者和資料表名稱——而你只想回傳與擁有者「Carl」相關的資料表，你需要輸入以下值：null、「Carl」。若未傳遞限制值，則使用該限制的預設值。這與輸入 null參數值的映射相同，而則不同於輸入空字串取得參數值。此時，空字串（“”）被視為指定參數的值。

另請參閱

GetSchema()

適用於