Skip to main content

This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.Opens in a new tab

For information on migrating to InterSystems IRISOpens in a new tab, see Why Migrate to InterSystems IRIS?

This version of the product is no longer supported, and this documentation is no longer updated regularly. See the latest version of this content.Opens in a new tab

Caché ODBC Environment Variables

This chapter describes the environment variables that control the Caché ODBC client driver. Typically you use these only for debugging or diagnostics.

CACHEODBCDEFTIMEOUT

This variable allows you to specify the duration of a timeout for a default login. Its value is in seconds.

CACHEODBCPID

This boolean variable enables the automatic appending of the process ID number to the log file name. A value of 1 enables appending and a value of 0 disables it. By default, appending is off.

With CACHEODBCPID enabled, if the base log file is CacheODBC.log and is in your current directory, then the process ID of 21933 generates a full log file name of “CacheODBC.log.21933”.

Both CACHEODBCPID and CACHEODBCTRACEFILE affect the file name. For example, on Windows if you use CACHEODBCTRACEFILE to set the base file name of the log file (for instance, to C:/home/mylogs/mylog.txt and enable CACHEODBCPID, then log file names will be of the form C:/home/mylogs/mylog.txt.21965.

CACHEODBCTRACE (UNIX® Only)

This boolean variable enables client driver logging. The default name for this file is CacheODBC.log.

For more information on logging, see the chapter “Logging.”

CACHEODBCTRACEFILE

This variable specifies the location and name of the log file. This can be useful for placing the log file in a unique directory or giving it a unique name. The default location of the log file is as follows:

  • For UNIX®, the log is generated in the current directory by default.

  • For Windows platforms other than Vista, the default location for the log file is %SYSTEMROOT%.

  • For Vista, the default location for the log file is %PUBLIC%\Logs\CacheODBC.log. This directory is accessible by all users and allows just one location for the log to be created.

Special Steps for Windows 2003

There are special requirements for setting up the trace file on Windows 2003, specifically for the situation where ODBC is being run by the Web server process. In addition to ensuring that the ODBC client has permission to write to the appropriate logging directory, you need to perform the following procedure:

  1. Specify CACHEODBCTRACEFILE as C:\ODBC_Logs\CacheODBC.log.

  2. When specifying the log file information, you also have the option of defining the CACHEODBCPID environment variable to include PID information. To do this, create another new variable with a name of CACHEODBCPID and a value of 1.

  3. Create the directory C:\ODBC_Logs and grant universal write access to this directory.

  4. Activate ODBC logging by selecting the ODBC Log check box in the DSN setup screen.

CACHEODBCTRACETHREADS

This variable controls whether the log also includes threading information. If the variable is 1, threading information is included; if it is 0, threading information is not included.

It can be useful to enable this additional kind of logging, if you need to debug a threaded application. However, it adds many extra lines to the log for most ODBC applications.


Previous sectionLogging
FeedbackOpens in a new tab