Environment Variables

Use environment variables to store different kinds of information.

Client Installation Environment Variables

Use connection environment variables to store installation-related information.

Environment Variable Name

Value

Description

HDB_INSTALL_NOPATH

<value>

Skips the PATH modification on Microsoft Windows.

Connection Environment Variables

Use connection environment variables to store connection-related information.

Environment Variable Name

Description

SAPLOCALHOST

Acts as the override for the virtual host name when connecting to a database.

HDB_NETWORK_GROUP

Acts as an override to the SQLDBC networkGroup connection property.

HDB_USE_IDENT

Acts as an override to the environment variable override for the <host-identity> portion of the secure user store location.

JDBC Tracing Environment Variables

Use tracing environment variables to store tracing-related information for JDBC.

Environment Variable Name

Value

Description

HDB_JDBC_TRACEFILE

<JDBC-trace-file-name>

Implicitly enables tracing for all JDBC connections established in the latest Java VM when combined with the HDB_JDBC_TRACEOPTIONS environment variable.

Changes to the trace settings file do not affect traces that are established using either both the traceFile and traceOptions connection properties or environment variables.

HDB_JDBC_TRACEOPTIONS

CONNECTION, API, PACKET, DISTRIBUTION, STATISTICS, CLEANERS, or DEBUG

Implicitly enables tracing for all JDBC connections established in the current JVM when combined with the HDB_JDBC_TRACEFILE environment variable.

Changes to the trace settings file do not affect traces that are established using either both the traceFile and traceOptions connection properties or environment variables.

SQLDBC Tracing Environment Variables

Use tracing environment variables to store tracing-related information for SQLDBC-based client interfaces.

Environment Variable Name

Value

Description

HDB_SQLDBC_TRACEFILE <SQLDBC-trace-file-name>

Implicitly enables tracing for all SQLDBC connections in the latest process when combined with the HDB_SQLDBC_TRACEOPTS environment variable.

The special file names "stdout" and "stderr" are supported to send trace information to stdout and stderr, respectively.

HDB_SQLDBC_TRACEOPTS <trace-options>

Implicitly enables tracing for all SQLDBC-based client connections when combined with the HDB_SQLDBC_TRACEFILE environment variable.

See the SQLDBC Tracing topic in this guide.

Secure User Store (hdbuserstore) Environment Variables

Use the secure user store (hdbuserstore) environment variables to store your hdbuserstore in one environment so that users on all hosts can connect to the SAP HANA database using the same secure store information.

Environment Variable Name

Value

Default

Description

HDB_USE_STORE_PATH <secure-store-path-location>

Specifies the environment variable override for the location of the secure user store file.

HDB_USE_IDENT

<host-identity>

Specifies the environment variable override for the <host-identity> portion of the secure user store location.

Node.js Environment Variables

Environment Variable Name

Default

Description

HDB_NODEJS_INSTALL_PLATFORMS

Specifies which platforms keep their native platform libraries at npm install time. This is done using a comma-separated list with no spaces.

The following platforms are currently installed:
  • darwinintel64-xcode7
  • linuxx86_64_alpine-gcc6
  • ntamd64-msvc2015
  • linuxppc64le-gcc48
  • linuxx86_64-gcc48
HDB_NODE_PLATFORM_CLEAN

Removes unnecessary native platform libraries at npm install time that will never be used after the Node driver is installed. To invoke this cleaning behavior, specify HDB_NODE_PLATFORM_CLEAN=1.

This is not recommended if you are vendoring dependencies.

HDB_NODEJS_THREADPOOL_SIZE

4

Specifies the number of worker threads in the thread pool.

ODBC Environment Variables

Use ODBC environment variables to store information gathered when using the ODBC API.

Environment Variable Name

Default

Description

ODBCINI $HOME/.odbc.ini

Specifies the environment variable override for the full path and filename location of the odbc.ini file (ODBC custom configuration file) on Linux and UNIX. This file defines the ODBC data sources on Linux and UNIX.

HOME

This depends on the operating system.

Specifies the environment variable override for the path location of the odbc.ini file (ODBC Custom Configuration File) on Linux and UNIX. This file defines ODBC data sources on Linux and UNIX.

Crypto Environment Variables

Use crypto-related environment variables to store secure information.

Environment Variable Name

Value

Description

SECUDIR

The location of the CommonCryptoLib identity file (*.pse).

Specifies the environment variable override for the path location of the keystore file that contains the client's identity.

HOME

The location of the OpenSSL directory (*.ssl).

Specifies the environment variable override for the path location of the .ssl directory, used by OpenSSL to find OpenSSL identity files (key.pem, trust.pem).

SAP_RETRIEVAL_PATH

The location of OpenSSL ssl directory (*.ssl).

Specifies the environment variable override for the path location of an SSL directory, used to find OpenSSL identity files (key.pem, trust.pem).

Kerberos Environment Variables

Use Kerberos environment variables to store authentication information.

Environment Variable Name

Default

Description

KRB5_CONFIG /etc/krb5.conf

Specifies the full path and file name location of the Kerberos configuration file.

KRB5_KTNAME /etc/krb5.keytab

Specifies the full path and filename location of the Kerberos keytab file.

.NET Environment Variables

Use environment variables to store information regarding your .NET application.

Environment Variable Name

Default

Description

HDBADONET C:\Program Files\SAP\hdbclient\ado.net\

Specifies the full path to the libadonetHDB.dll.

HDBDOTNETCORE C:\Program Files\SAP\hdbclient\dotnetcore\

(Microsoft Windows)

/usr/sap/hdbclient/dotnetcore

(Linux and macOS)

Specifies the full path to the libadonetHDB.dll, libadonetHDB.so, or libadonetHDB.dylib file.

Library Environment Variables

Use environment variables to store information regarding loading libraries.

Environment Variable Name

Description

PATH

Specifies the library path on the Microsoft Windows operating system.

LD_LIBRARY_PATH

Specifies the library path on the Solaris operating system.

DYLD_LIBRARY_PATH

Specifies the library path on the macOS operating system.

LIBPATH

Specifies the library path on the AIX operating system.

SAP HANA HDBSQL Environment Variables

Use environment variables to store information related to the SAP HANA HDBSQL command-line application.

Environment Variable

Default

Description

HDBSQL_EDITOR

Notepad (Microsoft Windows) and vi on other operating systems.

The first environment variable to be checked to set the editor program for HDBSQL. On Windows, the variable must be set to the full path of an .exe file.

Must be checked in order: HDBSQL_EDITOR, EDITOR, and VISUAL.

EDITOR

Notepad (Microsoft Windows) and vi on other operating systems.

The second environment variable to be checked to set the editor program for HDBSQL. On Windows, the variable must be set to the full path of an .exe file.

Must be checked in order: HDBSQL_EDITOR, EDITOR, and VISUAL.

VISUAL

Notepad (Microsoft Windows) and vi on other operating systems.

The third environment variable to be checked to set the editor program for HDBSQL. On Windows, the variable must be set to the full path of an .exe file.

Must be checked in order: HDBSQL_EDITOR, EDITOR, and VISUAL.

PAGER

Notepad (Microsoft Windows) and vi on other operating systems.

If set, this is used as the pager program for SAP HANA HDBSQL.