API functions in OceanBase Connector/ODBC|V2.0.9|OceanBase Connector/ODBC |docs|OceanBase Documentations

The following table summarizes all API functions available in the current version of OceanBase Connector/ODBC.

For more information about the API functions of ODBC, see ODBC API Reference.

Function name	Supported?	Description
SQLAllocConnect	Yes	Obtains a connection handle.
SQLAllocEnv	Yes	Obtains an environment handle allocated by the driver.
SQLAllocHandle	Yes	Obtains an environment, connection, statement, or descriptor handle.
SQLAllocStmt	Yes	Allocates a statement handle.
SQLBindCol	Yes	Binds application data buffers to columns in a result set.
SQLBindParameter	Yes	Binds a buffer to a parameter marker in an SQL statement.
SQLBrowseConnect	Yes (in Windows but not Linux)	Returns the attributes and attribute values required for connecting to a data source.
SQLBulkOperations	Yes	Performs bulk bookmark insert, update, delete, and fetch operations.
SQLCancel	Yes	Cancels processing on a statement.
SQLCancelHandle	Yes	Cancels processing on a connection or statement.
SQLCloseCursor	Yes	Closes a cursor opened in a statement and discards the pending result.
SQLColAttribute	Yes	Returns the descriptor information of a column in a result set.
SQLColAttributes	Yes	Returns the descriptor information of a column in a result set.
SQLColumnPrivileges	Yes	Returns the columns of the specified table and the privileges associated with the columns.
SQLColumns	Yes	Returns the names of columns in the specified table.
SQLConnect	Yes	Establishes a connection between the driver and a data source.
SQLCopyDesc	Yes	Copies the descriptor information of one descriptor handle to another.
SQLDescribeCol	Yes	Returns the result descriptor of a column in a result set.
SQLDisconnect	Yes	Closes the connection associated with the specified connection handle.
SQLDriverConnect	Yes	Establishes a connection between the driver and a data source.
SQLEndTran	Yes	Requests to commit or roll back a statement operation.
SQLError	Yes	Returns error or status information.
SQLExecDirect	Yes	Executes a statement.
SQLExecute	Yes	Executes a prepared statement.
SQLExtendedFetch	Yes	Returns the specified row in a result set.
SQLFetch	Yes	Returns the next row in a result set.
SQLFetchScroll	Yes	Returns a scrollable row of results.
SQLForeignKeys	Yes	Returns the names of columns used as foreign keys (if any) of the specified table.
SQLFreeConnect	Yes	Releases the connection handle.
SQLFreeEnv	Yes	Releases the environment handle.
SQLFreeHandle	Yes	Releases the environment, connection, statement, or descriptor handle.
SQLFreeStmt	Yes	Ends statement processing and discards the pending result, or releases all resources associated with the statement handle.
SQLGetConnectAttr	Yes	Returns the settings of the current connection attribute.
SQLGetConnectOption	Yes	Returns the value of a connection option.
SQLGetCursorName	Yes	Returns the name of the cursor associated with the specified statement.
SQLGetData	Yes	Retrieves the data of a single column or a single parameter in a result set.
SQLGetDescField	Yes	Returns the current setting or value of a single field.
SQLGetDescRec	Yes	Returns the current settings or values of multiple fields.
SQLGetDiagField	Yes	Returns a single field of the diagnostic data structure.
SQLGetDiagRec	Yes	Returns multiple fields of the diagnostic data structure.
SQLGetEnvAttr	Yes	Returns the current settings of an environment attribute.
SQLGetFunctions	Yes	Returns information about whether the driver supports a specific ODBC function.
SQLGetInfo	Yes	Returns information about the driver and data source associated with a connection.
SQLGetStmtAttr	Yes	Returns the current settings of a statement attribute.
SQLGetStmtOption	Yes	Returns the value of a statement option.
SQLGetTypeInfo	Yes	Returns supported data types.
SQLMoreResults	Yes	Determines whether more results are available in a statement.
SQLNumParams	Yes	Returns the number of parameters in an SQL statement.
SQLNumResultCols	Yes	Returns the number of columns in a result set.
SQLParamData	Yes (in MySQL mode but not Oracle mode)	Supplies parameter data for statement execution.
SQLParamOptions	Yes	Supplies parameter options for statement execution.
SQLPrepare	Yes	Preprocesses the SQL string to be executed.
SQLPrimaryKeys	Yes	Returns the names of columns used as primary keys of a table.
SQLProcedureColumns	Yes	Returns the input and output parameters and the columns that make up the result set for the specified procedure.
SQLProcedures	Yes	Returns the names of procedures stored in the specified data source.
SQLPutData	Yes (in MySQL mode but not Oracle mode)	Allows an application to send data of parameters or columns to the driver for statement execution.
SQLRowCount	Yes	Returns the number of rows affected by an insert, update, or delete request.
SQLSetConnectAttr	Yes	Sets connection attributes.
SQLSetConnectOption	Yes	Sets connection options.
SQLSetCursorName	Yes	Specifies the cursor name.
SQLSetDescField	Yes	Sets a single descriptor field.
SQLSetDescRec	Yes	Sets multiple descriptor fields.
SQLSetEnvAttr	Yes	Sets environment attributes.
SQLSetParam	Yes	Sets parameter attributes.
SQLSetPos	Yes	Sets the cursor position in a row set.
SQLSetScrollOptions	Yes	Sets cursor scrolling options.
SQLSetStmtAttr	Yes	Sets statement attributes.
SQLSetStmtOption	Yes	Sets statement options.
SQLSpecialColumns	Yes	Returns the best column set that uniquely identifies a row in the specified table, or columns automatically updated when a transaction updates any value in the row.
SQLStatistics	Yes	Retrieves statistics of a single table and indexes associated with the table.
SQLTablePrivileges	Yes	Returns tables and privileges associated with each table.
SQLTables	Yes	Returns tables, directories, schema names, or table types stored in a specific data source.
SQLTransact	Yes	Commits or rolls back a transaction.

The current version of OceanBase Connector/ODBC does not support the following API functions:

SQLCompleteAsync
SQLDataSources
SQLDescribeParam
SQLDrivers
SQLNativeSql