ODBC Function Summary
The following table lists ODBC functions, grouped by type of task, and includes the conformance designation and a brief description of the purpose of each function. For more information about conformance designations, see ODBC and the Standard CLI. For more information about the syntax and semantics for each function, see ODBC API Reference.
An application can call the SQLGetInfo function to obtain conformance information about a driver. To obtain information about support for a specific function in a driver, an application can call SQLGetFunctions.
| Task | Function name | Conformance | Purpose |
|---|---|---|---|
| Connecting to a data source | SQLAllocHandle | ISO 92 | Obtains an environment, connection, statement, or descriptor handle. |
| SQLConnect | ISO 92 | Connects to a specific driver by data source name, user ID, and password. | |
| SQLDriverConnect | ODBC | Connects to a specific driver by connection string or requests that the Driver Manager and driver display connection dialog boxes for the user. | |
| SQLBrowseConnect | ODBC | Returns successive levels of connection attributes and valid attribute values. When a value has been specified for each connection attribute, connects to the data source. | |
| Obtaining information about a driver and data source | SQLDataSources SQLDrivers |
ISO 92 ODBC |
Returns the list of available data sources. Returns the list of installed drivers and their attributes. |
| SQLGetInfo | ISO 92 | Returns information about a specific driver and data source. | |
| SQLGetFunctions | ISO 92 | Returns supported driver functions. | |
| SQLGetTypeInfo | ISO 92 | Returns information about supported data types. | |
| Setting and retrieving driver attributes | SQLSetConnectAttr SQLGetConnectAttr |
ISO 92 ISO 92 |
Sets a connection attribute. Returns the value of a connection attribute. |
| SQLSetEnvAttr | ISO 92 | Sets an environment attribute. | |
| SQLGetEnvAttr | ISO 92 | Returns the value of an environment attribute. | |
| SQLSetStmtAttr | ISO 92 | Sets a statement attribute. | |
| SQLGetStmtAttr | ISO 92 | Returns the value of a statement attribute. | |
| Setting and retrieving descriptor fields | SQLGetDescField SQLGetDescRec |
ISO 92 ISO 92 |
Returns the value of a single descriptor field. Returns the values of multiple descriptor fields. |
| SQLSetDescField | ISO 92 | Sets a single descriptor field. | |
| SQLSetDescRec | ISO 92 | Sets multiple descriptor fields. | |
| SQLCopyDesc | ISO 92 | Copies descriptor information from one descriptor handle to another. | |
| Preparing SQL requests | SQLPrepare | ISO 92 | Prepares a SQL statement for later execution. |
| SQLBindParameter | ODBC | Assigns storage for a parameter in a SQL statement. | |
| SQLGetCursorName | ISO 92 | Returns the cursor name associated with a statement handle. | |
| SQLSetCursorName | ISO 92 | Specifies a cursor name. | |
| SQLSetScrollOptions | ODBC | Sets options that control cursor behavior. | |
| Submitting requests | SQLExecute SQLExecDirect |
ISO 92 ISO 92 |
Executes a prepared statement. Executes a statement. |
| SQLNativeSql | ODBC | Returns the text of a SQL statement as translated by the driver. | |
| SQLDescribeParam | ODBC | Returns the description for a specific parameter in a statement. | |
| SQLNumParams | ISO 92 | Returns the number of parameters in a statement. | |
| SQLParamData | ISO 92 | Used in conjunction with SQLPutData to supply parameter data at execution time. (Useful for long data values.) | |
| SQLPutData | ISO 92 | Sends part or all of a data value for a parameter. (Useful for long data values.) | |
| Retrieving results and information about results | SQLRowCount SQLNumResultCols |
ISO 92 ISO 92 |
Returns the number of rows affected by an insert, update, or delete request. Returns the number of columns in the result set. |
| SQLDescribeCol | ISO 92 | Describes a column in the result set. | |
| SQLColAttribute | ISO 92 | Describes attributes of a column in the result set. | |
| SQLBindCol | ISO 92 | Assigns storage for a result column and specifies the data type. | |
| SQLFetch | ISO 92 | Returns multiple result rows. | |
| SQLFetchScroll | ISO 92 | Returns scrollable result rows. | |
| SQLGetData | ISO 92 | Returns part or all of one column of one row of a result set. (Useful for long data values.) | |
| SQLSetPos | ODBC | Positions a cursor within a fetched block of data and allows an application to refresh data in the rowset or to update or delete data in the result set. | |
| SQLBulkOperations | ODBC | Performs bulk insertions and bulk bookmark operations, including update, delete, and fetch by bookmark. | |
| SQLMoreResults | ODBC | Determines whether there are more result sets available and, if so, initializes processing for the next result set. | |
| SQLGetDiagField | ISO 92 | Returns additional diagnostic information (a single field of the diagnostic data structure). | |
| SQLGetDiagRec | ISO 92 | Returns additional diagnostic information (multiple fields of the diagnostic data structure). | |
| Obtaining information about the data source's system tables (catalog functions) | SQLColumnPrivileges SQLColumns |
ODBC Open Group |
Returns a list of columns and associated privileges for one or more tables. Returns the list of column names in specified tables. |
| SQLForeignKeys | ODBC | Returns a list of column names that make up foreign keys, if they exist for a specified table. | |
| SQLPrimaryKeys | ODBC | Returns the list of column names that make up the primary key for a table. | |
| SQLProcedureColumns | ODBC | Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures. | |
| SQLProcedures | ODBC | Returns the list of procedure names stored in a specific data source. | |
| SQLSpecialColumns | Open Group | Returns information about the optimal set of columns that uniquely identifies a row in a specified table, or the columns that are automatically updated when any value in the row is updated by a transaction. | |
| SQLStatistics | ISO 92 | Returns statistics about a single table and the list of indexes associated with the table. | |
| SQLTablePrivileges | ODBC | Returns a list of tables and the privileges associated with each table. | |
| SQLTables | Open Group | Returns the list of table names stored in a specific data source. | |
| Terminating a statement | SQLFreeStmt | ISO 92 | Ends statement processing, discards pending results, and, optionally, frees all resources associated with the statement handle. |
| SQLCloseCursor | ISO 92 | Closes a cursor that has been opened on a statement handle. | |
| SQLCancel | ISO 92 | Cancels the processing on a statement. | |
| SQLCancelHandle | ODBC | Cancels the processing on a statement or connection. | |
| SQLEndTran | ISO 92 | Commits or rolls back a transaction. | |
| Terminating a connection | SQLDisconnect SQLFreeHandle |
ISO 92 ISO 92 |
Closes the connection. Releases an environment, connection, statement, or descriptor handle. |