SqlConnection.GetSchemaAsync メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
オーバーロード
| Name | 説明 |
|---|---|
| GetSchemaAsync(CancellationToken) |
このSqlConnectionのデータ ソースのスキーマ情報を返す、GetSchema()の非同期バージョン。 スキーマの詳細については、「スキーマ コレクションのSQL Server」を参照してください。 |
| GetSchemaAsync(String, CancellationToken) |
GetSchema(String)の非同期バージョン。このSqlConnectionのデータ ソースのスキーマ情報を返し、スキーマ名に指定した文字列を使用します。 |
| GetSchemaAsync(String, String[], CancellationToken) |
GetSchema(String, String[])の非同期バージョン。このSqlConnectionのデータ ソースのスキーマ情報を返します。この場合、スキーマ名に指定した文字列と、制限値に指定した文字列配列を使用します。 |
GetSchemaAsync(CancellationToken)
このSqlConnectionのデータ ソースのスキーマ情報を返す、GetSchema()の非同期バージョン。 スキーマの詳細については、「スキーマ コレクションの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
キャンセル トークン。
返品
非同期操作を表すタスク。
注釈
SQL Serverの.NET Framework Data Providerでの非同期プログラミングの詳細については、「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
キャンセル トークン。
返品
非同期操作を表すタスク。
例外
collectionName は null として指定されます。
注釈
SQL Serverの.NET Framework Data Providerでの非同期プログラミングの詳細については、「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
キャンセル トークン。
返品
非同期操作を表すタスク。
例外
collectionName は null として指定されます。
注釈
restrictionValues パラメーターは、特定のコレクションの制限コレクションで指定される n 個の深さの値を指定できます。 特定の制限に値を設定し、他の制限の値を設定しないようにするには、上記の制限を null に設定し、値を指定する制限に適切な値を入力する必要があります。
この例として、"Tables" コレクションがあります。 "Tables" コレクションにデータベース、所有者、テーブル名の 3 つの制限があり、所有者 "Carl" に関連付けられているテーブルのみを取得する場合は、null、"Carl" の値を渡す必要があります。 制限値が渡されない場合は、その制限に既定値が使用されます。 これは、パラメーター値に空の文字列を渡すのとは異なり、 nullを渡すのと同じマッピングです。 その場合、空の文字列 ("") は、指定されたパラメーターの値と見なされます。