SqlConnection.GetSchemaAsync Метод
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Перегрузки
| Имя. | Описание |
|---|---|
| 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
Маркер отмены.
Возвращаемое значение
Задача, представляющая асинхронную операцию.
Комментарии
Дополнительные сведения об асинхронном программировании в Data Provider Data Provider SQL Server см. .NET в разделе 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.
Комментарии
Дополнительные сведения об асинхронном программировании в Data Provider Data Provider SQL Server см. .NET в разделе 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 , а затем поместить соответствующее значение для ограничения, для чего нужно указать значение.
Примером этого является коллекция "Таблицы". Если коллекция "Таблицы" имеет три ограничения- база данных, владелец и имя таблицы, и вы хотите вернуть только таблицы, связанные с владельцем "Carl", необходимо передать следующие значения: NULL, "Carl". Если значение ограничения не передается, значения по умолчанию используются для этого ограничения. Это то же сопоставление, что и передача, которая отличается от передачи nullпустой строки для значения параметра. В этом случае пустая строка ("") считается значением указанного параметра.