Function Summary

FUNCTION SUMMARY

How to Read the Tables

The following tables lists SOLID SQL API functions, grouped by type of task, and includes the ODBC conformance designation and a brief description of the purpose of each function. For more information about conformance designations, see "ODBC Conformance Levels" in Chapter 1, "Theory of Operation." For more information about the syntax and semantics for each function, see Chapter 13, "Function Reference."

Connecting to a Data Source

Task	Function Name	Conformance	Purpose
Connecting to a Data Source	SQLAllocEnv	Core	Obtains an environment handle. One environment handle is used for one or more connections.
	SQLAllocConnect	Core	Obtains a connection handle.
	SQLConnect	Core	Connects to a specific driver by data source name, user ID, and password.
	SQLDriverConnect	Level 1	Connects to a specific driver by connection string or requests that the Driver Manager and driver display connection dialog boxes for the user.
	SQLBrowseConnect	Level 2	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

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
Obtaining Information about a Driver and Data Source	SQLDataSources SQLDrivers	Level 2 Level 2	Returns the list of available data sources. Returns the list of installed drivers and their attributes.
	SQLGetInfo	Level 1	Returns information about a specific driver and data source.
	SQLGetFunctions	Level 1	Returns supported driver functions.
	SQLGetTypeInfo	Level 1	Returns information about supported data types.

Setting and Retrieving Driver Options

Task	Function Name	Conformance	Purpose
Setting and Retrieving Driver Options	SQLSetConnectOption SQLGetConnectOption	Level 1 Level 1	Sets a connection option. Returns the value of a connection option.
	SQLSetStmtOption	Level 1	Sets a statement option.
	SQLGetStmtOption	Level 1	Returns the value of a statement option.

Preparing SQL Requests

Task	Function Name	Conformance	Purpose
Preparing SQL Requests	SQLAllocStmt SQLPrepare	Core Core	Allocates a statement handle. Prepares an SQL statement for later execution.
	SQLBindParameter	Level 1	Assigns storage for a parameter in an SQL statement.
	SQLParamOptions	Level 2	Specifies the use of multiple values for parameters.
	SQLGetCursorName	Core	Returns the cursor name associated with a statement handle.
	SQLSetCursorName	Core	Specifies a cursor name.
	SQLSetScrollOptions	Level 2	Sets options that control cursor behavior.

Submitting Requests

Task	Function Name	Conformance	Purpose
Submitting Requests	SQLExecute SQLExecDirect	Core Core	Executes a prepared statement. Executes a statement.
	SQLNativeSql	Level 2	Returns the text of an SQL statement as translated by the driver.
	SQLDescribeParam	Level 2	Returns the description for a specific parameter in a statement.
	SQLNumParams	Level 2	Returns the number of parameters in a statement.
	SQLParamData	Level 1	Used in conjunction with SQLPutData to supply parameter data at execution time. (Useful for long data values.)
	SQLPutData	Level 1	Send part or all of a data value for a parameter. (Useful for long data values.)

Retrieving Results and Information about Results

Task	Function Name	Conformance	Purpose
Retrieving Results and Information about Results	SQLRowCount SQLNumResultCols	Core Core	Returns the number of rows affected by an insert, update, or delete request. Returns the number of columns in the result set.
	SQLDescribeCol	Core	Describes a column in the result set.
	SQLColAttributes	Core	Describes attributes of a column in the result set.
	SQLBindCol	Core	Assigns storage for a result column and specifies the data type.
	SQLFetch	Core	Returns a result row.
	SQLFetchPrev	SOLID Extensiom	Returns the previous result row.
	SQLExtendedFetch	Level 2	Returns multiple result rows.
	SQLGetData	Level 1	Returns part or all of one column of one row of a result set. (Useful for long data values.)
	SQLSetPos	Level 2	Positions a cursor within a fetched block of data.
	SQLMoreResults	Level 2	Determines whether there are more result sets available and, if so, initializes processing for the next result set.
	SQLError	Core	Returns additional error or status information.

Obtaing Information about System Tables

Task	Function Name	Conformance	Purpose
Obtaining information about the data source’s system tables (catalog functions)	SQLColumnPrivileges SQLColumns	Level 2 Level 1	Returns a list of columns and associated privileges for one or more tables. Returns the list of column names in specified tables.
	SQLForeignKeys	Level 2	Returns a list of column names that comprise foreign keys, if they exist for a specified table.
	SQLPrimaryKeys	Level 2	Returns the list of column name(s) that comprise the primary key for a table.
	SQLProcedureColumns	Level 2	Returns the list of input and output parameters, as well as the columns that make up the result set for the specified procedures.
	SQLProcedures	Level 2	Returns the list of procedure names stored in a specific data source.
	SQLSpecialColumns	Level 1	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	Level 1	Returns statistics about a single table and the list of indexes associated with the table.
	SQLTablePrivileges	Level 2	Returns a list of tables and the privileges associated with each table.
	SQLTables	Level 1	Returns the list of table names stored in a specific data source.

Terminating a Statement

Task	Function Name	Conformance	Purpose
Terminating a Statement	SQLFreeStmt	Core	Ends statement processing and closes the associated cursor, discards pending results, and, optionally, frees all resources associated with the statement handle.
	SQLCancel	Core	Cancels an SQL statement.
	SQLTransact	Core	Commits or rolls back a transaction.

Terminating a Connection

Task

Function Name

Conformance

Purpose

Terminating a
Connection

SQLDisconnect

SQLFreeConnect

Core

Core

Closes the connection.

Releases the connection handle.

SQLFreeEnv

Core

Releases the environment handle.