profile



Registers an user callback method that can be used for profiling. The callback method is invoked is invoked as each SQL statement finishes.

Arguments: The arguments are:
callBackObj [required] An instantiated object with a method that will be invoked for profiling. However, this argument can also be .nil to indicate that any installed profile callback is to be removed.
mthName [optional] The method name that will be invoked during a call back. By default, the method invoked will beprofileCallBack(). However, the user can specify an alternative method if desired. This argument is ignored when thecallbackObjargument is .nil.
userData [optional] This can be any Rexx object the user desires. The object will be sent as the third argument to the profile callback method when it is invoked. This argument is ignored when the callbackObj argument is .nil.
Return value: TheuserDataargument to a previous invocation of thetracemethod on the same database connection, or .nil if there has not been a previous invocation or theuserDataargument was not used on the previous invocation.
Remarks: By default, there is no profile callback installed. There can only be one profile callback per database connection. Setting a new profile callback automatically clears any previously installed callback. The callback method is invoked as each SQL statement finishes. The profile callback contains the original statement text and an estimate of wall-clock time of how long that statement took to run. The example profileCallBack method has complete details.
Details; The functionality of theprofilemethod is similar to that of the SQLite sqlite3_profile API.