• database
• EQ_DBSERVER
• EQ_DBUSER
• EQ_DBPASSWORD
• EQ_AUDIT_INFO
• EQ_DBLOGFILE / EQ_DBAPI_LOGFILE
• EQ_DBLOGFLAGS / EQ_DBAPI_LOGFLAGS
• EQ_DBCACHE
• EQ_DBENABLEIPC
• EQ_MKEYFILE
• EQ_MKEYID
• image3k
• EQ3K_DEBUG
• EQ3K__xyz dbopen alias
• EQ3K_MINCAPACITY
• EQ_DBTHREADSAFE
• query3k
• QSIN
• QSLIST
• LP
• language
• ELOQRC
• EQ_ELOQRC
• EQ_SHELL
• EQ_USE_IDLOK
• EQ_SYSID
• EQPATH
• EQCLSPATH
• eloq.cgi
• EQCGI_VOLUME
• EQCGI_MAXPOST
• EQCGI_MAXUPLOAD
• EQCGI_TMPDIR
• EQCGI_LOGFILE
• EQCGI_LOGLEVEL
• EQCGI_ARGS
• EQCGI_BIN
• fwutil
• FWUTIL_DEBUG_FLAGS
• platform
• SHLIB_PATH
• LD_LIBRARY_PATH

database

EQ_DBSERVER

Specifies the host name (or IP address) and service name (or TCP port) of the database server to connect by default, if the database name passed to DBOPEN() does not include the optional host and/or port specification.

Default is localhost:eloqdb. Syntax is [host][:service].

For example:

$ export EQ_DBSERVER=localhost:eloqdb  # the default, if not set

$ export EQ_DBSERVER=localhost  # omitting service defaults to eloqdb
$ export EQ_DBSERVER=:eloqdb    # omitting host defaults to localhost

$ export EQ_DBSERVER=127.0.0.1:8102  # using numeric IP and TCP port

EQ_DBUSER

Specifies the default user to connect the database server. If the user name starts with file: it is considered a reference to a file where the first line holds the user id and an optional second line the password.

For example:

$ export EQ_DBUSER=operator            # specified explicitly

$ export EQ_DBUSER=file:$HOME/db.user  # credentials in file

Access to a credentials file should be limited via file system security!

As of Eloquence B.08.20 the credentials file may also be created with the dbpasswd utility. This avoids using clear text passwords and adds flexibility such as specifying an expiration date for the credentials:

$ dbpasswd -f $HOME/db.user -r exp=4h -v operator
Enter password for operator:
Password verified successfully.
NOTE: Password file will expire at 2014-08-04 19:05:15

$ export EQ_DBUSER=file:$HOME/db.user

EQ_DBPASSWORD

Specifies the default password used to connect the database server. If the password starts with file: it is considered a reference to a file holding the password.

For example:

$ export EQ_DBPASSWORD=secret              # not recommended

$ export EQ_DBPASSWORD=file:$HOME/db.pass  # password in file

Access to a password file should be limited via file system security!

As of Eloquence B.08.20 a credentials file may also be created with the dbpasswd utility and referenced with the EQ_DBUSER environment variable. This avoids using clear text passwords and adds flexibility such as specifying an expiration date for the credentials.

See EQ_DBUSER and dbpasswd for details.

EQ_AUDIT_INFO

May be used to specify application specific audit information supplementing process information (such as operating system, ip address, process id, etc) that the database client library uploads to the database server when connecting.

Useful for analysis of eloqdb LogFile, eloqdb SessionStatFile or fwaudit.

EQ_DBAPI_LOGFILE

Specifies the log file to be used with EQ_DBAPI_LOGFLAGS. Default is stderr.

For example:

$ export EQ_DBAPI_LOGFILE=/tmp/client.log

As of B.08.30 EQ_DBLOGFILE is an alias for EQ_DBAPI_LOGFILE.

Also see EQ_DBAPI_LOGFLAGS.

EQ_DBAPI_LOGFLAGS

Specifies the logging flags used with the Eloquence database client library. This is intended to allow logging of database operations with custom applications.

For example:

$ export EQ_DBAPI_LOGFILE=/tmp/client.log
$ export EQ_DBAPI_LOGFLAGS="*2K1X1"            # enable eqdb tracing

$ eloqcore QUERY,SYSTEM  # invoke any eqdb based program, e.g. QUERY
 ...

$ unset EQ_DBAPI_LOGFLAGS               # disable eqdb tracing again

As of B.08.30 EQ_DBLOGFLAGS is an alias for EQ_DBAPI_LOGFLAGS.

Also see EQ_DBAPI_LOGFILE.

EQ_DBCACHE

May be used to disable the use of client side caching. When set to a zero value caching is disabled. If undefined or set to a nonzero value, caching is enabled.

Values >= 2 specify a max. number of cached records from the server process. (Values other than 0 or 1 are not recommended unless instructed by support.)

EQ_DBENABLEIPC

Specifies whether or not IPC communication may be used on a local connection.

By default, the client library and the database server determine whether a connection is local, so that the more efficient IPC communication method is used. This is usually the desired behavior.

However, when using a tunneled network connection to a remote server, for example with SSH port forwarding, overriding the default behavior by setting EQ_DBENABLEIPC=0 may be necessary.

EQ_MKEYFILE
EQ_MKEYID

May be used to supply a (set of) master key(s) to access encrypted content with utilities such as fwaudit, dbbexp or dbcfix (invoked with the -M option).

EQ_MKEYFILE specifies a colon separated list of master key files.
Up to 3 key files may be specified. The default key file is eqdb.key.

EQ_MKEYID specifies a colon separated list of master key id's.
Up to 6 master key id's may be present.

For example:

$ export EQ_MKEYFILE=test.key
$ export EQ_MKEYID=alpha:beta

$ fwaudit ... -M ...

Enter passphrase for alpha:
alpha: Master key activated

Enter passphrase for beta:
beta: Master key activated
 ...

image3k

EQ3K_DEBUG

May be used to specify a log file for tracing DB calls to the image3k library.

For example:

$ export EQ3K_DEBUG=/tmp/client.log    # enable image3k tracing

$ query3k      # invoke any image3k based program, e.g. query3k
 ...

$ unset EQ3K_DEBUG              # disable imaga3k tracing again

Note that the EQ3K_DEBUG trace file is a plain text file.

EQ3K__xyz dbopen alias

As a replacement for MPE file equations, DBOPEN checks for an environment variable that matches the database name. If found, the value of this variable is used to replace the database name passed to DBOPEN.

To be effective, the environment variable needs to start with the prefix "EQ3K__" followed by the upshifted database name. Any dot characters (.) in the database name are replaced by underscore characters (_).

For example:

Database Name   Environment Variable
--------------- ---------------------
sample          EQ3K__SAMPLE
sample.test     EQ3K__SAMPLE_TEST

The following example uses the EQ3K__ alias mechanism to cause image3k DBOPEN calls specifying either TOYDB.PUB or TOYDB.PUB.SYS to actually open the database named TOYDB:

$ export EQ3K__TOYDB_PUB=TOYDB
$ export EQ3K__TOYDB_PUB_SYS=TOYDB

$ query3k      # invoke any image3k based program, e.g. query3k
 ...

EQ3K_MINCAPACITY

May be used to "override" the capacity returned by DBINFO mode 202 and 205. By default, Eloquence returns the highest record number ever used for the data set plus some padding, depending on the physical entry size. This is typically the desired behavior with dynamic dataset expansion.

EQ_DBTHREADSAFE

The Eloquence B.08.30 database client libraries are thread safe by default and separate database accesses from multiple threads while enabling concurrent database access within. This may affect backwards compatibility with applications that use multiple threads but do not take advantage of the builtin thread handling.

Setting EQ_DBTHREADSAFE=0 may be used to disable the thread handling in the database client libraries. Please note that disabling thread safety has no performance advantage. This option was introduced with PE83-210322x.

query3k

QSIN

May be used to specify a file name to redirect the query3k input source.

Also see "Running query3k" section in query3k documentation.

QSLIST
LP

Output of the query3k utility may be redirected by using the QSLIST or LP environment variables. If both are specified the QSLIST environment variable takes precedence.

The QSLIST environment variable by default specifies the name of an output file. The LP environment variable by default specifies a process to send the output to (such as the spooler). If neither is defined, any O=LP output is sent to the default printer queue (equivalent to LP=lp or LP=qlp on Windows).

Also see "Redirecting the output" section in query3k documentation.

language

ELOQRC
EQ_ELOQRC

May be used to define the path to the user specific configuration file that is used instead of the default user specific configuration file ($HOME/.eloqrc on HP-UX and Linux, %HOME%/eloq.rc on Windows).

Unix example:

$ export ELOQRC=/usr/local/etc/team.eloqrc

$ eloqcore MYPROGRAM,MYVOLUME

Windows example:

C:\> set ELOQRC=%USERPROFILE%\eloq.rc

C:\> eloqcore MYPROGRAM,MYVOLUME

EQ_SHELL

May be used on HP-UX and Linux to specify the shell that is used by the non-interactive COMMAND "!..." statement to process system commands. By default the shell /usr/bin/sh is used on HP-UX and /bin/sh is used on Linux.

EQ_USE_IDLOK

May be used to specify the use of the idlok terminal option. A zero value disables use, a non-zero value enables this option.

This is intended as a workaround for bugs in the HP-UX xcurses library that may result in corrupted screen output. Currently, the IDLOK terminal option is disabled for HP terminal types on HP-UX.

EQ_SYSID

The return value of the SYSID$ function may either be configured in the Eloquence configuration files (elog.config, etc.) or defined with the EQ_SYSID environment variable. The environment variable takes precedence.

EQPATH

May be used to specify a path to be used by eloqcore for loading program files, opening data files, or loading forms and dialog files (text based dialog). If set, EQPATH has precedence over a PATH definition in the eloq.config file(s).

EQCLSPATH

May be used to specify a class path to be used by eloqcore for LOAD CLASS statements and autoloading of class methods. If set, an EQCLSPATH environment variable has precedence over a CLSPATH definition in the eloq.config file(s).

eloq.cgi

EQCGI_VOLUME

Enforces that Eloquence CGI programs are located in the configured Eloquence volume regardless whether a different volume or an absolute path is specified in the request URL.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_MAXPOST

Maximum number of bytes accepted in a single HTTP POST request. Default is 1M (1 MB, megabyte), 0 = unlimited.

For example:

• 256000 : 250 KB (kilobytes, 250 * 1024 bytes)
• 250k : 250 KB (also 250K)
• 10M : 10 MB (10 * 1024 * 1024 bytes, also 10m)

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_MAXUPLOAD

Maximum size accepted for a single uploaded file. Default is 1M (1 megabyte), 0 = unlimited.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_TMPDIR

Directory used to hold temporary files (ie. upload files).
If not set the system-defined default directory is used.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_LOGFILE

If set, the eloq.cgi program writes the specified log file. The log file directory must allow create/write access to the user and/or group running the web server process.

If not set, eloq.cgi log messages are outout to the web server error log.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_LOGLEVEL

Specifies which eloq.cgi events are logged:

• 0 or not set: Error conditions are logged.
• 1: Informational messages are logged in addition.
• 2: Debug messages are logged in addition. Logs details about request type and decoded arguments.
• 3: More verbose debug messages are logged in addition.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_ARGS

Additional arguments to be passed to Eloquence eloqcore which runs the CGI program.

For example, to create a trace file:

SetEnv EQCGI_ARGS "-t3 -log /tmp/eloqcgi.log"

Please note that the options -n -b are always passed.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

EQCGI_BIN

Location of Eloquence eloqcore. Setting this might be useful for debugging purposes.

Also see the "eloq.cgi configuration" section in the Eloquence CGI documentation.

fwutil

FWUTIL_DEBUG_FLAGS

May be used to enable fwutil library debug mode. Setting this environment variable to "R1" is similar to calling Fwu_verbose() with parameter value 1.

platform

LD_LIBRARY_PATH

May be used to adjust the loading of shared libraries on HP-UX and Linux platforms. While not Eloquence specific, it is relevant when loading the image3k and/or database client libraries, for example.

SHLIB_PATH

HP-UX legacy equivalent of LD_LIBRARY_PATH. It is searched in addition to LD_LIBRARY_PATH to locate shared libraries.