API Trace

API tracing is available via the -t 16 or -t 0x10 command line option. The API trace messages trace calls to DBLIB (Microsoft SQL Server) or OCI (Oracle). The following messages may appear when you use API tracing:

Message

Description

Abort_Transaction:

This message indicates that the DATABridge Client is making an API call to rollback the current transaction group.

Begin_Transaction:

This message, which is limited to the DATABridge Client for Microsoft SQL Server, indicates that DATABridge Client is making an API call to start a transaction group.

BindColumnPtr:

This message is limited to the DATABridge Client for Oracle when the configuration parameter aux_stmts has a nonzero value. It indicates that the columns involving a host variable in the SQL statement that was just executed are being bound to a memory address. This message follows every Parse_SQL message.

Bind_Record: col=number, name=colname, ofs=number, size=number, type=number

This message appears when the various data columns referenced explicitly or implicitly in a select statement are bound to fields in a program structure. This messages lists the column number (col=number), item name (name=colname), offset of the field in the structure expressed as a hexadecimal number (entry ofs=number), size of the field (in bytes) expressed as a decimal number (size=number), and code for the sql_type of the field (type=number).

Commit_Transaction:

This message indicates that the DATABridge Client is making an API call to commit the current transaction group.

Close_Database:

This message indicates that a database session has been closed. The DATABridge Client typically uses two database sessions at a time.

Execute_PreParsed_
SQL for cursor number

This message is immediately followed by the SQL_DATA message, which displays the actual values of the host variables for the pre-parsed SQL statement that is being executed.

Execute_SQL:

This message indicates that the DATABridge Client called the Execute_SQL procedure, which executes all SQL statements, except for Oracle SQL involving auxiliary cursors.

Fetch_Results: No more rows

This message appears when the DATABridge Client loads the client control tables and indicates the no more rows are available in the select statement result.

Fetch_Results: Row retrieved

This message appears when the DATABridge Client loads the client control tables and indicates that the DATABridge Client successfully read the row when it retrieved the results of a select statement.

Get_SQL_Ret_Status:

This message, which is limited to the DATABridge Client for Microsoft SQL Server, indicates that the DATABridge Client called the dbretstatus entry of the DBLIB API.

Open_Cursor: Opened cursor number

This message is limited to the DATABridge Client for Oracle when the configuration parameter aux_stmts has a nonzero value. It indicates that Oracle is creating a new cursor. The DATABridge Client uses an algorithm that looks for the least used cursor to ensure that the most frequently used cursors are not deallocated.

Open_Database: user=userid, pwd=password, [srvr=server,]
db=database, rslt=dbhandle

This message indicates that the DATABridge Client established a database session with the given parameters. The value dbhandle is the address of the internal structure used to hold the connection parameters and is expressed as a hexadecimal number. The DATABridge Client typically uses two database sessions. The server designation (srvr=server) refers to the Microsoft SQL Server.

Parse_SQL: SQL[number]=stmt

This message is limited to the DATABridge Client for Oracle when the configuration parameter aux_stmts has a nonzero value. It indicates that the SQL statement involving a host variable is being parsed using the cursor in question. Oracle continues to use the same cursor number to execute this statement.

Process_SQL:
SQL = SQLText

This message, which should not be confused with a similar SQL tracing message, overrides the SQL trace when both SQL and API tracing are enabled.

Process_SQL_Results:

This message, which is limited to the DATABridge Client for Microsoft SQL Server, indicates that the DATABridge Client is calling the dbresults entry of the DBLIB API to determine if there are any unprocessed results in addition to executing a SQL statement. This is required when you add select statements to the stored procedures generated by the DATABridge Client. The configuration parameter clear_sp_results forces the Client to use this method instead of executing the SQL, assuming that there are no results to process.

SQL_DATA[number]=
...|...|...

This message, which should not be confused with a similar SQL tracing message, overrides the SQL trace when both SQL and API tracing are enabled.

SQL Server message: number, state number, severity number, MSG_Text

This message, which is limited to the DATABridge Client for Microsoft SQL Server, indicates that the DATABridge Client received the SQL Server message. The DATABridge Client typically does not display these messages when the severity level is 0; however, it does so when API tracing is enabled.