Connectivity Series client‑side log file

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS

The VORTEX_API_LOGFILE environment variable turns on logging and specifies the path and name of the file that will log statements issued to the database by the xfODBC driver or SQL Connection.


The path and name of the Vortex API log file you want to produce. You do not need to specify a filename extension.


Vortex API logging is helpful in debugging queries. By recording Vortex API calls made by the xfODBC driver on a Windows client, you can see the exact SQL statement issued to the database, debug SQL statement errors, and verify optimization. Use VORTEX_API_LOGOPTS to set options for the log file. If you set VORTEX_API_LOGFILE without 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 VORTEX_API_LOGFILE and VORTEX_API_LOGOPTS (and reboot if necessary). Logging slows performance, and the log files can quickly fill your disk.

Setting location

The environment. We recommend that you use log files to debug in a stand‑alone configuration. If you need to use Vortex API logging in a client/server configuration, set the environment variables on the client. 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