Data access variables

These environment variables that set run‑time options, which are used as the xfODBC driver accesses the database. Unless otherwise noted, the xfODBC Database Administrator (DBA) and dbcreate do not use these environment variables, and they do not affect the way the system catalog is generated. For information on environment variables that affect the system catalog, see System catalog generation variables.

Data Access Variables

Environment variable

Purpose

For more information…

GENESIS_HOME

Specifies the location of the connect file. (DBA and dbcreate also use this environment variable.)

Specifying the connect file location (GENESIS_HOME)

GENESIS_INITSQL

Specifies a file that contains predefined SQL statements.

Creating a file for query processing options

GENESIS_MSG_FILE

Sets the name and location of the error message file. (DBA and dbcreate also use this environment variable.)

Specifying the error message file (GENESIS_MSG_FILE)

SDMS_AUDIT

(UNIX) Specifies the path and filename of the Synergy DBMS log file in UNIX environments. (Use SDMS_AUDIT_SRV for Windows.)

Synergy DBMS logging

SDMS_AUDIT_FULL

Turns on Synergy DBMS logging.

Synergy DBMS logging

SDMS_AUDIT_MODE

Instructs xfODBC to log I/O control modes for each file operation.

Synergy DBMS logging

SDMS_AUDIT_SRV

(Windows and UNIX) Specifies the path and filename for generated auditing files for file operations on a server or a threaded Windows program.

Synergy DBMS logging

SDMS2_FULL

Records additional ODBC calls to the Synergy database. Unlike SDMS2_LOG, this environment variable can be set in Windows, UNIX, and OpenVMS environments.

Synergy DBMS logging and Synergy DBMS logging on OpenVMS

SDMS2_LOG

(OpenVMS) Specifies the path and filename of the Synergy DBMS log file.

Synergy DBMS logging on OpenVMS

SODBC_INIFIL

Specifies the path and filename of the environment setup file.

Specifying the location of the environment setup file (SODBC_INIFIL)

SODBC_MCBA

Instructs xfODBC to skip records that contain the MCBA deleted‑record characters—four right brackets (]]]]) at the beginning or end of a record.

Recognizing the MCBA deleted-record characters

SYNBASEDATE

Sets the base date for conversion of date fields with the JJJJJJ format. The default date is 1752‑09‑14 (14 September 1752).

Once you’ve modified data in the database, do not change the SYNBASEDATE value or the database will be corrupted. Each date is stored as the difference between the entered date and the SYNBASEDATE value. Changing this value changes the way dates are stored and read.

Setting the base date for Julian day conversions

SYNCENTURY

Specifies the cutoff year for a sliding window mechanism that converts two‑digit years to four‑digit years. SYNCENTURY determines the cutoff year and affects only input dates with two‑digit year formats (YYMMDD, YYJJJ, etc.).

Converting dates returned without centuries

TRIM_HOME

Specifies the location of the lib directory that contains trim.ini (UNIX only) and trim.msg files used for system catalog caching.

Invalid parameter or argument (UNIX)

VORTEX_API_LOGFILE

Turns on logging and specifies the path and filename of a log file used to log statements issued to the database by the xfODBC driver.

Vortex API logging (Windows)

VORTEX_API_LOGOPTS

Specifies options for the file produced by VORTEX_API_LOGFILE.

Vortex API logging (Windows)

VORTEX_HOST_LOGFILE

Turns on logging and specifies the path and filename of the logfile used to log statements passed to SQL OpenNet from the xfODBC driver.

Vortex host logging

VORTEX_HOST_LOGOPTS

Specifies options for the file produced by VORTEX_HOST_LOGFILE.

Vortex host logging

VORTEX_HOST_SYSLOG

Instructs the SQL OpenNet server to generate messages for the event log (Windows), syslog (UNIX), or the operator console (OpenVMS) when an attempt to connect to an SQL OpenNet server causes fatal errors.

Error logging for xfODBC

VORTEX_ODBC_CHAR

Determines how xfODBC describes strings (SQL_VARCHAR or SQL_CHAR).

Changing the way xfODBC describes strings

VORTEX_ODBC_DATETIME

Determines how datetime columns are retrieved.

Changing the data type returned for datetime columns

VORTEX_ODBC_TIME

Determines how time columns are described.

Changing the data type for returned time columns and Time columns and ADO.NET

VORTEX_SHM_BASE

Sets the base address for system catalog caching.

Improving performance with system catalog caching

VORTEX_SHM_FILE

Specifies the location and name of synodbccache.dat, a file used for system catalog caching.

Improving performance with system catalog caching