Поделиться через


Сводка ПО API табличного параметра ODBC

Применимо:SQL Server База данных SQL Azure Управляемый экземпляр SQL Azureazure Synapse Analytics AnalyticsPlatform System (PDW)

ODBC поддерживает табличное значение параметров (табличное значение параметров) с помощью усовершенствований нескольких существующих функций API. Эти функции работают вместе, чтобы описать схемы параметров с табличным значением, привязать и передать наборы строк, получить метаданные и управлять записями дескриптора.
В следующих разделах можно упорядочить соответствующие функции ODBC в логические группы, чтобы понять, как работает каждая часть конвейера параметров с табличным значением.

Функции обнаружения схемы схемы табличного значения и метаданных

Эти функции помогают приложению обнаруживать структуру табличных параметров, включая метаданные столбцов, определения параметров и доступные типы данных SQL.

Функция Цель
SQLColumns Извлекает метаданные столбца для табличного параметра или типа таблицы
SQLDescribeParam Возвращает метаданные для параметра параметра с табличным значением, включая тип, точность и масштабирование.
SQLGetTypeInfo Извлекает типы данных SQL, поддерживаемые драйвером для столбцов параметров с табличным значением
SQLPrimaryKeys Предоставляет сведения о ключевых столбцах в типах таблиц, используемых с параметрами с табличным значением
SQLProcedureColumns Извлекает метаданные для параметров хранимой процедуры, связанных с табличным значением.
SQLTables Перечисляет таблицы и типы таблиц, доступные в качестве источников для объявлений параметров с табличным значением

Привязка параметров с табличным значением и передача данных

Эти функции обрабатывают структурированные данные привязки к параметрам, передаче данных на сервер или потоковой передачи строк во время выполнения.

Функция Цель
SQLBindParameter Привязка табличного параметра к буферу приложения или набору строк
SQLParamData Извлекает следующую часть потока возвращаемого табличного параметра при использовании данных во время выполнения
SQLPutData Отправляет табличное значение данные параметров в блоках во время операций выполнения данных

Выполнение инструкции для параметров с табличным значением

Эти функции выполняют инструкции SQL, которые ссылаются на табличные параметры и управляют жизненным циклом выполнения.

Функция Цель
SQLExecDirect Выполняет инструкцию SQL, которая использует параметры с табличным значением, не подготавливая его сначала
SQLExecute Выполняет ранее подготовленную инструкцию SQL, включающую параметры параметра с табличным значением.

Дескриптор и управление атрибутами для параметров с табличным значением

Используйте эти функции для управления полями дескриптора и атрибутами инструкций, необходимыми для правильного описания наборов строк и структурированных параметров.

Функция Цель
SQLGetDescField Извлекает метаданные дескриптора для столбцов или наборов строк с табличным значением
SQLSetDescField Задает метаданные дескриптора для столбцов или наборов строк с табличным значением
SQLSetDescRec Задает полную запись дескриптора для структурированных данных параметров табличного значения
SQLGetStmtAttr Извлекает атрибуты инструкции, влияющие на поведение выполнения табличного параметра
SQLSetStmtAttr Задает атрибуты инструкции, такие как размеры набора строк или флаги потоковой передачи для операций с табличным значением параметров

Диагностика и обработка ошибок для параметров с табличным значением

Используйте эти функции, чтобы помочь приложениям обнаруживать ошибки, предупреждения или сообщения о состоянии во время привязки и выполнения табличного параметра.

Функция Цель
SQLGetDiagField Извлекает диагностические сведения, созданные во время обработки параметров с табличным значением