Library ODBC Compatible Functions

From Recital Documentation Wiki
Revision as of 14:41, 31 March 2009 by Yvonnemilne (Talk | contribs)

Jump to: navigation, search

On Recital supported UNIX and Linux platforms, the following ODBC compatible functions are also available in addition to the standard Recital/Library functions.


FUNCTION DESCRIPTION
SQLAllocConnect() [1] Allocate a connection handle.
SQLAllocEnv() [2] Allocate an environment handle.
SQLAllocStmt() [3] Allocate a new statement and associate it with a connection handle.
SQLBindCol() [4] Bind application storage space to columns in a result set.
SQLBindParameter() [5] Bind an application variable to a parameter marker.
SQLColAttributes() [6] Return descriptor information for a column.
SQLColumnPrivileges() [7] Return a list of columns and associated privileges for the specified table.
SQLColumns() [8] Return a list of column names for the specified tables.
SQLConnect() [9] Establish a connection to a database.
SQLDataSources() [10] Return information about a data source. This function is implemented solely by the Driver Manager.
SQLDescribeCol() [11] Return column information.
SQLDescribeParam() [12] Return the description of a parameter marker.
SQLDisconnect() [13] Disconnect a connection from a database.
SQLError() [14] Return information about the most recent error.
SQLExecDirect() [15] Prepare and execute an SQL statement.
SQLExecImmediate() Execute an SQL statement.
SQLExecute() [16] Execute a previously prepared dynamic SQL statement.
SQLFetch() [17] Advance cursor to next row.
SQLForeignKeys() [18] Return a list of foreign keys in the specified table.
SQLFreeConnect() [19] Free connection from a database.
SQLFreeEnv() [20] Free environment handle.
SQLFreeStmt() [21] Close a cursor.
SQLGetConnectOption() [22] Return the current setting of a connection option.
SQLGetCursorName() [23] Associate a cursor name with a statement handle.
SQLGetData() [24] Retrieve data for a single column in the result set. It can be called multiple times to retrieve variable length data in parts.
SQLGetInfo() [25] Return general information about the currently connected DBMS.
SQLGetStmtOption() [26] Set options related to the HSTMT.
SQLGetTypeInfo() [27] Return information about data types supported by the data source.
SQLLockTable() Apply the specified lock to the table.
SQLMoreResults() [28] Determine whether there are more results available on a statement containing SELECT, UPDATE, INSERT, or DELETE statements and, if so, initialize processing for those results.
SQLNativeSql() [29] Return the SQL string as translated by the driver.
SQLNumParams() [30] Return the number of parameter markers.
SQLNumResultCols() [31] Returns the number of columns in a result set.
SQLParamData() [32] Used in conjunction with SQLPutData to supply parameter data at statement execution time.
SQLPrepare() [33] Associate a cursor name with a statement handle.
SQLPrimaryKeys() [34] Return the column names that make up the primary key for a table.
SQLProcedureColumns() [35] Return a list of input and output parameters, as well as the columns that make up the result set for the specified procedures.
SQLProcedures() [36] Return the list of procedure names stored in a specific data source. Procedure is a generic term used to describe an executable object, or a named entity that can be invoked using input and output parameters.
SQLPutData() [37] Allow an application to send data for a parameter or column to the driver at statement execution time.
SQLRowCount() [38] Build a scroll cursor.
SQLSavePoint() Set or roll back a save point on the current transaction.
SQLSetConnectOption() [39] Set connection options.
SQLSetCursorName() [40] Associate a cursor name with a statement handle.
SQLSetLocking() Change the transaction locking type.
SQLSetParam() [41] Bind application storage space to columns in a result set.
SQLSetPos() [42] Set the cursor position.
SQLSetStmtOption() [43] Set SQL statement options.
SQLSpecialColumns() [44] Set up fetch for special column names.
SQLStatistics() [45] Retrieve a list of statistics about a single table and the indexes associated with the table.
SQLTablePrivileges() [46] Return a list of tables and the privileges associated with each table.
SQLTables() [47] Return a list of table names in the specified data source.
SQLTransact() [48] Commit or roll back the current transaction.


NOTE: To use the ODBC compatible functions, the following shared object library must be loaded or linked into your application:


<path>/recital-X.X/shared/libodbc.recital.so