VORTEX_API_LOGOPTS
Connectivity Series client-side log options
WTSupported in traditional Synergy on Windows
|
WNSupported in Synergy .NET on Windows
|
USupported on UNIX
|
VSupported on OpenVMS
|
The VORTEX_API_LOGOPTS environment variable specifies options for the file determined by VORTEX_API_LOGFILE.
Value
One or more of the following, separated by a plus sign (+):
Append logging information to existing log file.
Log only statements with errors.
Perform full logging.
Create a separate file for each channel when using multiple database channels.
Set an option that enables Synergy/DE Developer Support to play back an operation.
Log data for support.
Create a file that contains SQL commands. Specify the filename (minus extension) and path (optional) with VORTEX_API_LOGFILE. The extension is .sql.
Log execution time for statements.
Discussion
Vortex API logging is helpful in debugging queries. By recording Vortex API calls made by the xfODBC driver and SQL Connection, you can see the exact SQL statement issued to the database, debug SQL statement errors, and verify optimization.
Use the VORTEX_API_LOGFILE environment variable to specify the name and location of the log file that is generated. If you set VORTEX_API_LOGFILE without setting VORTEX_API_LOGOPTS, the log file includes a list of all operations along with a total count for each operation.
Once you have successfully logged the error, turn logging off by unsetting the VORTEX_API_LOGFILE and VORTEX_API_LOGOPTS environment variables (and reboot if necessary). Logging slows performance, and the log files can quickly fill your disk.
Setting location
The environment. For services such as web servers that use the xfODBC driver, you can use the Env. variables field in the xfODBC Setup window to set this environment variable on the client.
Used by
xfODBC, SQL Connection
See also
- VORTEX_API_LOGFILE environment variable
- Vortex API logging (Windows)
- SQL Connection troubleshooting and error logging
Examples
To record a full operation log and CPU time,
VORTEX_API_LOGOPTS=FULL+TIME