This is an old revision of the document!
Omnidex reserves some environment variables for its own use. Some of required, but most are optional. These variables either point to the location of the software or configure aspects of the software.
PATH points to the directory where the Omnidex executables reside. This variable is a system variable, and is not Omnidex-specific. The PATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value.
If the PATH is not set, users will either be required to run all Omnidex executables from the directory in which the executable resides or must pass the fully qualified path to the executable.
UNIX export PATH="/omnidex/bin:$PATH"
Windows set PATH="c:\Program Files\Omnidex 5.1\bin";%PATH%
LD_LIBRARY_PATH points to the directory where shared libraries reside. This variable is a system variable, and is not Omnidex-specific. The LD_LIBRARY_PATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value. LD_LIBRARY_PATH is only used on UNIX operating systems.
UNIX export LD_LIBRARY_PATH="/omnidex/lib"
CLASSPATH points to the directory where the Omnidex.jar file resides and is required for Java development on all platforms. This variable is a system variable, and is not Omnidex-specific. The CLASSPATH variable is likely to contain other paths. To ensure that existing settings are not overridden, append the setting to the existing value.
Omnidex.jar is located in the bin subdirectory of the Omnidex root directory on the server, and in the lib subdirectory of the Omnidex Client root directory on the client machine.
UNIX export CLASSPATH="/omnidex/bin/Omnidex.jar:$CLASSPATH"
Windows set CLASSPATH="c:\Program Files\Omnidex 5.1\bin\Omnidex.jar";%CLASSPATH%
TMPDIR points to a directory where Omnidex temporary files are built. This variable is not Omnidex-specific on UNIX, but is not frequently used on Microsoft Windows.
It is recommended that TMPDIR be set to a directory with plenty of available disk space, especially when building Omnidex indexes. It is also recommended that TMPDIR be placed on a separate drive, and preferably a separate disk controller, from the underlying data and the Omnidex index files.
UNIX export TMPDIR="/temp"
Windows set TMPDIR=d:\temp
The following environment variables must be set for Omnidex to function properly.
OMNIDEX_HOME points to the root directory of the Omnidex server software.
UNIX export OMNIDEX_HOME="/omnidex"
Windows set OMNIDEX_HOME=c:\program files\omnidex 5.1
The following environment variables are optional and can be used to configure the behavior of Omnidex.
The OMNIDEX_DEBUG variable controls Omnidex debugging and is described in Omnidex Debugging.
The OMNIDEX_QUALIFICATION_THRESHOLD variable controls when Omnidex indexes are used for qualifying rows in a table and is described in Configuring Omnidex Optimization.
The OMNIDEX_AGGREGATION_THRESHOLD variable controls when Omnidex indexes are used for aggregating rows in a table and is described in Configuring Omnidex Optimization.
The OMNIDEX_DATE_FORMAT, OMNIDEX_TIME_FORMAT and OMNIDEX_DATETIME_FORMAT variables control the default format for dates and times when converted from their internal binary format to a displayable character format. The environment variable can be set to a string that references the following tokens:
Date Token | Return Datatype | Description |
---|---|---|
YEAR | INTEGER | Returns Year in CCYY format. |
MONTH | INTEGER | Returns numeric Month from 1 to 12. |
DAY | INTEGER | Returns numeric Day of the Month. |
HOUR | INTEGER | Returns numeric Hour. |
MINUTE | INTEGER | Returns numeric Minute. |
SECOND | INTEGER | Returns numeric Second. |
A | STRING(2) | Returns Lowercase am/pm indicator. |
AA | STRING(2) | Uppercase AM/PM indicator. |
D | INTEGER | Returns numeric Day of the Month (1 to 31). |
0D | STRING(2) | Zero-filled day-of-month (01, 02, 03) |
DD | INTEGER | Day of year in one, two or three digit format. |
0DD | STRING(3) | Zero-filled day of year (044) |
F | INTEGER | Non-zero-filled fraction of a second (1, 2) |
0F | STRING(2) | Zero-filled fraction of a second (01, 02) |
H | INTEGER | 12-hour, non-zero-filled hour of day (12, 1) |
0H | STRING(2) | 12-hour, zero-filled hour of day (12, 01) |
HH | INTEGER | 24-hour, non-zero-filled hour of day (24, 1) |
0HH | C STRINg(2) | 24-hour, zero-filled hour of day (24, 01) |
J | DOUBLE | Non-zero-filled Julian date (1, 2) |
0J | STRING(11) | Zero-filled Julian date (01, 02) |
M | INTEGER | Non-zero-filled month number (1-January, 2-February) |
0M | STRING(2) | Zero-filled day-of-month number (01-January, 02-February) |
MM | STRING(3) | Three-character month abbreviation (Jan, Feb) |
MMM | STRING(varies) | Fully spelled month (January, February) |
N | INTEGER | Non-zero-filled minute of hour (1, 2) |
0N | STRING(2) | Zero-filled minute of hour (01, 02) |
Q | INTEGER | Quarter of the year (1) |
STRING(2) | Quarter of the year abbreviation (Q1) | |
QQQ | STRING(varies) | Quarter of the year name (First Quarter) |
S | INTEGER | Non-zero-filled second of minute (1, 2) |
0S | STRING(2) | Zero-filled second of minute (01, 02) |
W | INTEGER | Day of the week number (1-Sunday, 2-Monday) |
WW | STRING(3) | Three-character day-of-week abbreviation (Sun, Mon) |
WWW | STRING(varies) | Fully spelled day-of-week (Sunday, Monday) |
YY | STRING(2) | Two-digit year (99, 00) |
YYYY | INTEGER | Four-digit year (1999, 2000) |
The following example establishes the default format for dates:
UNIX export OMNIDEX_DATE_FORMAT="MMM D, YYYY"
Windows set OMNIDEX_DATE_FORMAT="MMM D, YYYY"
> select birthdate from individuals; BIRTHDATE ------------------- July 14, 1938 November 22, 1957 July 28, 1960 August 22, 1929 July 9, 1933 August 1, 1944 September 14, 2004
The ODXSQLINIT variable points to an initialization file used by the OdxSQL Program. This initialization file contains OdxSQL statements to be run when OdxSQL is launched. Typically, these statements are SET commands; however, any OdxSQL commands are allowed.
UNIX export ODXSQLINIT="/class/.odxsqlinit"
Windows set ODXSQLINIT=d:\class\.odxsqlinit"
The ODXSQLHISTORY variable points to a history file used by the OdxSQL Program. This history file contains statements that have been run in the OdxSQL program. Note that if multiple sessions point to the same file, their statements will all be written to the same file.
UNIX export ODXSQLINIT="/class/.odxsql_history"
Windows set ODXSQLINIT=d:\class\.odxsql_history"
See also: