Other Environment Variables

• DBINSTAL
• ODXSQL
• ORACLE
• Other Operating System Environment Variables
• Other Configuration Environment Variables
• Debugging

DBINSTAL Environment Variables

The following variables can be set before running DBINSTAL.

The required variables (above) must also be set prior to running DBINSTAL.

Don't forget to set the temporary directory variables prior to running DBINSTAL. DBINSTAL uses the temporary directory while building the indexes.

OA_MAX_ROWS

OA_MAX_ROWS restricts the number of rows to be indexed. This setting should be used for testing purposes only.

Setting OA_MAX_ROWS to 100 for example, will cause the first 100 rows of each table to be indexed. However, there is no guarantee, in a parent/child relationship, that the 100 rows in the child table will belong to any of the 100 rows in the parent table.

Unix

export OA_MAX_ROWS=100

Windows

set OA_MAX_ROWS=100

OA_SKIP_ROWS

OA_SKIP_ROWS skips indexing the specified number of rows.

Unix

export OA_SKIP_ROWS=100

Windows

set OA_SKIP_ROWS=500

OA_OPTIONS

OA_OPTIONS sets the connect options that will be used to connect to the Environment Catalog. Options can be any valid options for a CONNECT.

Unix

export OA_OPTIONS="WRITE"

Windows

set OA_OPTIONS="READ"

ODXSQL Environment Variables

The following variables can be set before running ODXSQL.

The required variables (above) must also be set prior to running ODXSQL.

ODXSQL_API

ODXSQL_API specifies which API to use, OA (default) or ODBC during this ODXSQL session.

If running ODXSQL on a client machine where the Omnidex server software has not been installed, this variable MUST be set to ODBC, since the OA API does not exist on the client.

Unix

export ODXSQL_API="OA"

Windows

set ODXSQL_API="ODBC"

ODXSQLHIST

ODXSQL_HIST_FILE points to an ODXSQL History File. By default, the ODXSQL command history is written to .odxsql_history. Use this variable to write the history to a different file.

Unix

export ODXSQLHIST="myhistoryfile.txt"

Windows

set ODXSQLHIST="myhistoryfile.txt"

ODXSQLINIT

ODXSQLINIT points to an ODXSQL Init File. This file can contain initialization settings that will be set when ODXSQL starts. This is very useful for set options.

Unix

export ODXSQLINIT="init_file.txt"

Windows

set ODXSQLINIT="init_file.txt"

Oracle Environment Variables

The following variables apply when going against an Oracle database only.

ORACLE_SID

ORACLE_SID specifies the Oracle SID. This is an Oracle environment variable required by Omnidex.

Unix

See the Oracle documentation for syntax

Windows

See the Oracle documentation for syntax

DA_ORA_DATE_FMT

DA_ORA_DATE_FMT controls which date format Omnidex uses for dates when communicating with Oracle. Syntax is the same as Oracle's NLS_DATE_FORMAT.

Unix

See the Oracle documentation for syntax on Oracle's NLS_DATE_FORMAT

Windows

See the Oracle documentation for syntax on Oracle's NLS_DATE_FORMAT

Operating System Environment Variables

The following variables are Operating System environment variables optionally used by Omnidex. See the operating system documentation for syntax specifications.

COMSPEC

Windows Only. Points to the command shell, CMD.EXE for example.

SHELL

Unix Only. Points to the shell to use for commands.

SHLIB_PATH

Unix Only. Points to the path for shared libraries.

HOME

All Platforms. Points to the HOME directory.

USERNAME

Current system user name.

Configuration Environment Variables

The following variables are Omnidex configuration environment variables optionally used by Omnidex.

OA_API_TIMEOUT

OA_API_TIMEOUT control timeout of API. Setting value is in seconds.

Unix

export OA_API_TIMEOUT=180

Windows

set OA_API_TIMEOUT=360

OA_ASK_RETRIEVAL_THRESHOLD

OA_ASK_RETRIEVAL_THRESHOLD controls the ASK_RETRIEVAL_THRESHOLD. Setting value is an number representing a percentage, 1 for 1 %, 2 for 2%, etc...

Setting OA_ASK_RETRIEVAL_THRESHOLD tells Omnidex at what point it may be more efficient to retrieve the rows and order or aggregate the results manually, where the threshold is the percentage of qualified rows out of total rows in the table.

Unix

export OA_ASK_RETRIEVAL_THRESHOLD=1.5

Windows

set OA_ASK_RETRIEVAL_THRESHOLD=2

OA_MDK_RETRIEVAL_THRESHOLD

OA_MDK_RETRIEVAL_THRESHOLD controls the MDK_RETRIEVAL_THRESHOLD. Setting value is an number representing a percentage, 1 for 1 %, 2 for 2%, etc...

Setting OA_MDK_RETRIEVAL_THRESHOLD tells Omnidex at what point it may be more efficient to perform a sequential scan than to use the Omnidex indexes, where the threshold is the percentage of qualified rows out of total rows in the table.

Unix

export OA_MDK_RETRIEVAL_THRESHOLD=1

Windows

set OA_MDK_RETRIEVAL_THRESHOLD=2

OMNIDEX_API_OSCOMMANDS

OMNIDEX_API_OSCOMMANDS controls whether operating system commands may be performed through oaexecsql against the $COMMAND table. Setting value is ON or OFF.

The purpose of the environment variable is to prevent or allow client applications to execute system commands through ODBC and JDBC. Default is OFF.

Unix

export OMNIDEX_API_OSCOMMANDS=ON

Windows

set OMNIDEX_API_OSCOMMANDS=OFF

OMNIDEX_COMMIT_EVERY

OMNIDEX_COMMIT_EVERY controls how often to commit on an INSERT. Defines how often Omnidex asks the underlying database to commit updates. Default is 32.

Unix

export OMNIDEX_COMMIT_EVERY=50

Windows

set OMNIDEX_COMMIT_EVERY=100

Top