OpenText Analytics Database 26.2.x – Variables

Connecting-To: DBNAME

Mon, 01 Jan 0001 00:00:00 +0000

The name of the database to which you are currently connected. DBNAME is set every time you connect to a database (including program startup), but it can be unset.

Connecting-To: ECHO

Mon, 01 Jan 0001 00:00:00 +0000

If set to all, all lines entered from the keyboard or from a script are written to the standard output before they are parsed or run.

To select this behavior on program start-up, use the switch -a. If set to queries, vsql merely prints all queries as they are sent to the server. The switch for this is -e.

Connecting-To: ECHO_HIDDEN

Mon, 01 Jan 0001 00:00:00 +0000

When this variable is set and a backslash command queries the database, the query is first shown. This way you can study the OpenText™ Analytics Database internals and provide similar functionality in your own programs. (To select this behavior on program start-up, use the switch -E.)

If you set the variable to the value noexec, the queries are just shown but are not actually sent to the server and run.

Connecting-To: ENCODING

Mon, 01 Jan 0001 00:00:00 +0000

The current client character set encoding.

Connecting-To: HISTCONTROL

Mon, 01 Jan 0001 00:00:00 +0000

If this variable is set to ignorespace, lines that begin with a space are not entered into the history list. If set to a value of ignoredups, lines matching the previous history line are not entered. A value of ignoreboth combines the two options. If unset, or if set to any other value than those previously mentioned, all lines read in interactive mode are saved on the history list.

Source: Bash.

Connecting-To: HISTSIZE

Mon, 01 Jan 0001 00:00:00 +0000

Specifies how much storage space is allocated to store the history of SQL statements issued in the current vsql session. vsql uses this setting, by default 500, to calculate the size of the history buffer:

HISTSIZE * 50 (bytes)

where 50 bytes approximates the average length of a SQL statement. The actual length of SQL statements in the current session determines how many statements vsql stores.

HISTSIZE has no effect on the history that is stored in .vsql_history.

Source: Bash

Connecting-To: HOST

Mon, 01 Jan 0001 00:00:00 +0000

The database server host you are currently connected to. This is set every time you connect to a database (including program startup), but can be unset.

Connecting-To: IGNOREEOF

Mon, 01 Jan 0001 00:00:00 +0000

If unset, sending an EOF character (usually Control+D) to an interactive session of vsql terminates the application. If set to a numeric value, that many EOF characters are ignored before the application terminates. If the variable is set but has no numeric value, the default is 10.

Source: Bash.

Connecting-To: ON_ERROR_STOP

Mon, 01 Jan 0001 00:00:00 +0000

By default, if a script command results in an error, for example, because of a malformed command or invalid data format, processing continues. If you set ON_ERROR_STOP to ON in a script and an error occurs during processing, the script terminates immediately.

For example:

=> \set ON_ERROR_STOP ON

Note

If you invoke the script on Linux with vsql -f, vsql returns with error code 3 to indicate that an error occurred in the script.

Connecting-To: PORT

Mon, 01 Jan 0001 00:00:00 +0000

The database server port to which you are currently connected. This is set every time you connect to a database (including program start-up), but can be unset.

Connecting-To: PROMPT1 PROMPT2 PROMPT3

Mon, 01 Jan 0001 00:00:00 +0000

These specify what the prompts vsql issues look like. See Prompting for details.

Connecting-To: QUIET

Mon, 01 Jan 0001 00:00:00 +0000

This variable is equivalent to the command line option -q. It is probably not too useful in interactive mode.

Connecting-To: ROWS_AT_A_TIME

Mon, 01 Jan 0001 00:00:00 +0000

ROWS_AT_A_TIME is set by default to 1000, and retrieves results as blocks of rows of that size. The column formatting for the first block is used for all blocks, so in later blocks some entries could overflow.

When formatting results, OpenText™ Analytics Database buffers ROWS_AT_A_TIME rows in memory to calculate the maximum column widths. It is possible that rows after this initial fetch are not properly aligned if any of the field values are longer than those see in the first ROWS_AT_A_TIME rows. ROWS_AT_A_TIME can be unset with vsql meta-command\unset to guarantee perfect alignment. However, this requires re-buffering the entire result set in memory and might cause vsql to fail if the result set is too big.

Connecting-To: SINGLELINE

Mon, 01 Jan 0001 00:00:00 +0000

This variable is equivalent to the command line option -S.

Connecting-To: SINGLESTEP

Mon, 01 Jan 0001 00:00:00 +0000

This variable is equivalent to the command line option -s.

Connecting-To: USER

Mon, 01 Jan 0001 00:00:00 +0000

The database user you are currently connected as. This is set every time you connect to a database (including program startup), but can be unset.

Connecting-To: VERBOSITY

Mon, 01 Jan 0001 00:00:00 +0000

This variable can be set to the values default, verbose, or terse to control the verbosity of error reports.

Connecting-To: VSQL_HOME

Mon, 01 Jan 0001 00:00:00 +0000

By default, the vsql program reads configuration files from the user's home directory. In cases where this is not desirable, the configuration file location can be overridden by setting the VSQL_HOME environment variable in a way that does not require modifying a shared resource.

In the following example, vsql reads configuration information out of /tmp/jsmith rather than out of ~.

# Make an alternate configuration file in /tmp/jsmith
mkdir -p /tmp/jsmith
echo "\\echo Using VSQLRC in tmp/jsmith" > /tmp/jsmith/.vsqlrc
# Note that nothing is echoed when invoked normally
vsql
# Note that the .vsqlrc is read and the following is
# displayed before the vsql prompt
#
# Using VSQLRC in tmp/jsmith
VSQL_HOME=/tmp/jsmith vsql

Connecting-To: VSQL_SSLMODE

Mon, 01 Jan 0001 00:00:00 +0000

VSQL_SSLMODE specifies how (or whether) clients (like admintools) use SSL when connecting to servers. The default value is prefer, meaning to use SSL if the server offers it. Legal values are require, prefer, and disable. This variable is equivalent to the command-line -m option (or --sslmode).

Connecting-To: TOTP

Mon, 01 Jan 0001 00:00:00 +0000

Specify the current Time-based One-time Password (Totp) value. The Totp is sent to the server in the connection string for validation. If MFA is enforced and you do not provide a Totp, a dialog is displayed. You need to enter the Totp before proceeding with authentication. Totp values are generated at 30-second intervals. A Totp code remains valid for up to 90 seconds.