7.1 Справочник по API Connector/ODBC
В этом разделе приводятся сводные данные по функциям ODBC, сгруппированные по функциональности.
Для получения полного справочника по API ODBC обратитесь к Справочнику программиста ODBC по адресу http://msdn.microsoft.com/ru-ru/library/ms714177.aspx.
Приложение может вызвать функцию SQLGetInfo, чтобы получить информацию о соответствии Connector/ODBC. Чтобы получить информацию о поддержке конкретной функции в драйвере, приложение может вызвать SQLGetFunctions.
Примечание
Для обеспечения обратной совместимости драйвер Connector/ODBC поддерживает все устаревшие функции.
В следующих таблицах представлены вызовы API Connector/ODBC, сгруппированные по задачам:
Таблица 7.1 Вызовы API ODBC для подключения к источнику данных
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLAllocHandle | Да | ISO 92 | Получает дескриптор среды, подключения, оператора или дескриптора. |
SQLConnect | Да | ISO 92 | Подключается к определенному драйверу по имени источника данных, идентификатору пользователя и паролю. |
SQLDriverConnect | Да | ODBC | Подключается к определенному драйверу по строке подключения или запрашивает, чтобы диспетчер драйверов и драйвер отобразили диалоговые окна подключения для пользователя. |
SQLAllocEnv | Да | Устаревший | Получает дескриптор среды, выделенный драйвером. |
SQLAllocConnect | Да | Устаревший | Получает дескриптор подключения |
Таблица 7.2 Вызовы API ODBC для получения информации о драйвере и источнике данных
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLDataSources | Нет | ISO 92 | Возвращает список доступных источников данных, обрабатываемых диспетчером драйверов. |
SQLDrivers | Нет | ODBC | Возвращает список установленных драйверов и их атрибутов, обрабатываемых диспетчером драйверов. |
SQLGetInfo | Да | ISO 92 | Возвращает информацию о конкретном драйвере и источнике данных. |
SQLGetFunctions | Да | ISO 92 | Возвращает поддерживаемые функции драйвера. |
SQLGetTypeInfo | Да | ISO 92 | Возвращает информацию о поддерживаемых типах данных. |
Таблица 7.3 Вызовы API ODBC для установки и получения атрибутов драйвера
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLSetConnectAttr | Да | ISO 92 | Устанавливает атрибут подключения. |
SQLGetConnectAttr | Да | ISO 92 | Возвращает значение атрибута подключения. |
SQLSetConnectOption | Да | Устаревший | Устанавливает параметр подключения |
SQLGetConnectOption | Да | Устаревший | Возвращает значение параметра подключения |
SQLSetEnvAttr | Да | ISO 92 | Устанавливает атрибут среды. |
SQLGetEnvAttr | Да | ISO 92 | Возвращает значение атрибута среды. |
SQLSetStmtAttr | Да | ISO 92 | Устанавливает атрибут оператора. |
SQLGetStmtAttr | Да | ISO 92 | Возвращает значение атрибута оператора. |
SQLSetStmtOption | Да | Устаревший | Устанавливает параметр оператора |
SQLGetStmtOption | Да | Устаревший | Возвращает значение параметра оператора |
Таблица 7.4 Вызовы API ODBC для подготовки SQL-запросов
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLAllocStmt | Да | Устаревший | Выделяет дескриптор оператора |
SQLPrepare | Да | ISO 92 | Подготавливает SQL-запрос для последующего выполнения. |
SQLBindParameter | Да | ODBC | Назначает хранилище для параметра в SQL-запросе. Connector/ODBC 5.2 добавляет поддержку параметров “out” и “inout” через спецификаторы типа SQL_PARAM_OUTPUT или SQL_PARAM_INPUT_OUTPUT. (“Out” и “inout” параметры не поддерживаются для столбцов LONGTEXT и LONGBLOB.) |
SQLGetCursorName | Да | ISO 92 | Возвращает имя курсора, связанное с дескриптором оператора. |
SQLSetCursorName | Да | ISO 92 | Устанавливает имя курсора. |
SQLSetScrollOptions | Да | ODBC | Устанавливает параметры, которые управляют поведением курсора. |
Таблица 7.5 Вызовы API ODBC для отправки запросов
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLExecute | Да | ISO 92 | Выполняет подготовленный оператор. |
SQLExecDirect | Да | ISO 92 | Выполняет оператор |
SQLNativeSql | Да | ODBC | Возвращает текст SQL-запроса, переведенный драйвером. |
SQLDescribeParam | Нет | ODBC | Возвращает описание для определенного параметра в операторе. Не поддерживается Connector/ODBC — возвращаемые результаты не должны использоваться. |
SQLNumParams | Да | ISO 92 | Возвращает количество параметров в операторе. |
SQLParamData | Да | ISO 92 | Используется совместно с SQLPutData для предоставления данных параметра во время выполнения. (Полезно для длинных значений данных.) |
SQLPutData | Да | ISO 92 | Отправляет часть или все значение данных для параметра. (Полезно для длинных значений данных.) |
Таблица 7.6 Вызовы API ODBC для получения результатов и информации о результатах
| Имя функции | Connector/ODBC поддерживает? | Стандарт | Назначение |
|---|---|---|---|
SQLRowCount | Да | ISO 92 | Возвращает количество строк, затронутых запросом вставки, обновления или удаления. |
SQLNumResultCols | Да | ISO 92 | Возвращает количество столбцов в наборе результатов. |
SQLDescribeCol | Да | ISO 92 | Описывает столбец в наборе результатов. |
SQLColAttribute | Да | ISO 92 | Описывает атрибуты столбца в наборе результатов. |
SQLColAttributes | Да | Устаревший | Описывает атрибуты столбца в наборе результатов. |
SQLFetch | Да | ISO 92 | Возвращает несколько строк результатов. |
SQLFetchScroll | Да | ISO 92 | Возвращает прокручиваемые строки результатов. |
SQLExtendedFetch | Да | Устаревший | Возвращает прокручиваемые строки результатов. |
SQLSetPos | Да | ODBC | Позиционирует курсор в блоке извлеченной данных и позволяет приложению обновлять данные в наборе строк или обновлять или удалять данные в наборе результатов. |
SQLBulkOperations | Да | ODBC | Выполняет массовые операции вставки и массовые операции с закладками, включая обновление, удаление и извлечение по закладке. |
Таблица 7.7 Вызовы API ODBC для извлечения информации об ошибках или диагностических данных
| Имя функции | Поддерживается Connector/ODBC? | Стандарт | Назначение |
|---|---|---|---|
SQLError | Да | Устаревший | Возвращает дополнительную информацию об ошибках или состоянии |
SQLGetDiagField | Да | ISO 92 | Возвращает дополнительную диагностическую информацию (одно поле структуры диагностических данных). |
SQLGetDiagRec | Да | ISO 92 | Возвращает дополнительную диагностическую информацию (несколько полей структуры диагностических данных). |
Таблица 7.8 Вызовы API ODBC для получения информации о системных таблицах источника данных (функции каталога)
| Имя функции | Поддерживается Connector/ODBC? | Стандарт | Назначение |
|---|---|---|---|
SQLColumnPrivileges | Да | ODBC | Возвращает список столбцов и связанных с ними привилегий для одной или нескольких таблиц. |
SQLColumns | Да | X/Open | Возвращает список имён столбцов в указанных таблицах. |
SQLForeignKeys | Да | ODBC | Возвращает список имён столбцов, составляющих внешние ключи, если они существуют для указанной таблицы. |
SQLPrimaryKeys | Да | ODBC | Возвращает список имён столбцов, составляющих первичный ключ таблицы. |
SQLSpecialColumns | Да | X/Open | Возвращает информацию об оптимальном наборе столбцов, уникально идентифицирующих строку в указанной таблице, или столбцы, которые автоматически обновляются при обновлении любого значения в строке транзакцией. |
SQLStatistics | Да | ISO 92 | Возвращает статистику по одной таблице и список индексов, связанных с этой таблицей. |
SQLTablePrivileges | Да | ODBC | Возвращает список таблиц и привилегий, связанных с каждой таблицей. |
SQLTables | Да | X/Open | Возвращает список имён таблиц, хранящихся в конкретном источнике данных. |
Таблица 7.9 Вызовы API ODBC для выполнения транзакций
| Имя функции | Поддерживается Connector/ODBC? | Стандарт | Назначение |
|---|---|---|---|
SQLTransact | Да | Устаревший | Подтверждает или отменяет транзакцию |
SQLEndTran | Да | ISO 92 | или . |
Таблица 7.10 Вызовы API ODBC для завершения обработки оператора
| Имя функции | Поддерживается Connector/ODBC? | Стандарт | Назначение |
|---|---|---|---|
SQLFreeStmt | Да | ISO 92 | Завершает обработку оператора, отбрасывает ожидаемые результаты и, при необходимости, освобождает все ресурсы, связанные с дескриптором оператора. |
SQLCloseCursor | Да | ISO 92 | Закрывает курсор, открытый на дескрипторе оператора. |
SQLCancel | Да | ISO 92 | Отменяет SQL-оператор. |
Таблица 7.11 Вызовы API ODBC для завершения соединения
| Имя функции | Поддерживается Connector/ODBC? | Стандарт | Назначение |
|---|---|---|---|
SQLDisconnect | Да | ISO 92 | Закрывает соединение. |
SQLFreeHandle | Да | ISO 92 | Освобождает дескриптор окружения, соединения, оператора или дескриптора. |
SQLFreeConnect | Да | Устаревший | Освобождает дескриптор соединения. |
SQLFreeEnv | Да | Устаревший | Освобождает дескриптор окружения. |
© 2025 Oracle
Licensed under the GPLv2 License.
