OpenText Analytics Database 26.2.x – Command-line options

Connecting-To: -A --no-align

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

-A or --no-align switches to unaligned output mode. The default output mode is aligned.

Connecting-To: -a --echo-all

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

-a or --echo-all prints all input lines to standard output as they are read. This is more useful for script processing than interactive mode. It is equivalent to setting the variable ECHO to all.

Connecting-To: -c --command

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

-c command or--command command runs one command and exits. This is useful in shell scripts.

Use either:

A command string that can be completely parsed by the server that does not contain features specific to vsql
A single meta-command

You cannot mix SQL and vsql meta-commands. You can, however, pipe the string into vsql as shown:

echo "\\timing\\\\select * from t" | ../Linux64/bin/vsql
                Timing is on.
                i | c | v
                ---+---+---
                (0 rows)

Note

If you use double quotes (") with echo, you must double the backslashes ().

Connecting-To: -d --dbname

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

-d db-name or --dbname db-name specifies the name of the database to connect to. This is equivalent to specifying db-name as the first non-option argument on the command line.

Connecting-To: -E

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

-E displays queries generated by internal commands.

Connecting-To: -e --echo-queries

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

-e --echo-queries copies all SQL commands sent to the server to standard output as well. This is equivalent to setting the variable ECHO to queries.

Connecting-To: -r --workload

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

-r --workload lets you specify the name of a workload. If a routing rule is associated with that workload, your connection is routed to the subcluster reserved for that workload. For details, see Workload routing.

You can also specify a workload with the VSQL_WORKLOAD environment variable. For details, see vsql environment variables.

Connecting-To: -F --field-separator

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

-F separator or --field-separator separator specifies the field separator for unaligned output (default: "|") (-P fieldsep=). (See -A --no-align.) This is equivalent to \pset fieldsep or \f.

To set the field separator value to a control character, use your shell's control character escape notation. In Bash, you specify a control character in an argument using a dollar sign ($) followed by a string contained in single quotes. This string can contain C-string escapes (such as \t for tab), or a backslash () followed by an octal value for the character you want to use.

The following example demonstrates setting the separator character to tab (\t), vertical tab (\v) and the octal value of vertical tab (\013).

$ vsql -At -c "SELECT * FROM testtable;"
A|1|2|3
B|4|5|6

$ vsql -F $'\t' -At -c "SELECT * FROM testtable;"
A       1       2       3
B       4       5       6

$ vsql -F $'\v' -At -c "SELECT * FROM testtable;"
A
 1
  2
   3
B
 4
  5
   6
$ vsql -F $'\013' -At -c "SELECT * FROM testtable;"
A
 1
  2
   3
B
 4
  5
   6

Connecting-To: -f --file

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

-f filename or --file filename uses filename as the source of commands instead of reading commands interactively. After the file is processed, vsql terminates.

If filename is a hyphen (-), standard input is read.

Using this option is different from writing vsql < filename. Using -f enables some additional features such as error messages with line numbers. Conversely, the variant using the shell's input redirection should always yield exactly the same output that you would have gotten had you entered everything manually.

Connecting-To: ? --help

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

-? --help displays help about vsql command line arguments and exits.

Connecting-To: -H --html

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

-H --html turns on HTML tabular output. This is equivalent to \pset format html or the \H command.

Connecting-To: -h --host

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

-h hostname or --host hostname specifies the host name of the machine on which the server is running. Use this flag to connect to OpenText™ Analytics Database remotely.

The following requirements and restrictions apply:

If you use client authentication with a Kerberos connection method of either gss or krb5, you must specify -h hostname.
Use the -h option if you want to connect to the database from a local connection, but want to use the an authentication record with the access method HOST (rather than LOCAL).

Connecting-To: -i -- timing

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

Enables the \timing meta-command. You can only use this command with the -c --command and -f --file commands:

$VSQL -h host1 -U user1 -d VMart -p 15 -w ****** -i -f transactions.sql

You can only use -i with the -c (command) and -f (filename) commands. For more information see Command-line options.

From the command line enter the -i option before running a session to turn timing on. For example:

$VSQL -h host1 -U user1 -d VMart -p 15 -w ****** -i -f transactions.sql

$VSQL-h host1 -U user1 -d VMart -p 15 -w ****** -i -c "SELECT user_name,
ssl_state, authentication_method, client_authentication_name, client_type FROM sessions
WHERE session_id=(SELECT session_id FROM current_session);"

Connecting-To: -g --label

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

Assigns a client label to the connection at the start of the session. Client connections and their labels appear in the SESSIONS and some Data collector tables like DC_REQUESTS_ISSUED. Client labels set with this option appear in DC_SESSION_STARTS.

If used, this option takes precedence over the VSQL_CLIENT_LABEL environment variable.

To set client labels for ongoing sessions, use SET_CLIENT_LABEL.

Connecting-To: -l --list

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

-l or --list returns all available databases, then exits. Other non-connection options are ignored. This command is similar to the internal command \list.

Connecting-To: -m --sslmode

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

-m or --sslmode specifies the policy for making SSL connections to the server. Options are verify-full, verify-ca require, prefer, and disable. You can also set the VSQL_SSLMODE variable to achieve the same effect. If the variable is set, the command-line option overrides it.

For information about these modes, see Configuring TLS for ODBC Clients.

Connecting-To: -n

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

-n disables command line editing.

Connecting-To: -o --output

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

-o filename or --output filename writes all query output into file filename. This is equivalent to the vsql meta-command \o.

Connecting-To: -P --pset

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

-P assignment or --pset assignment lets you specify printing options in the style of \pset on the command line. Note that you have to separate name and value with an equal sign instead of a space. Thus to set the output format to LaTeX, you could write -P format=latex.

Connecting-To: -p --port

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

-p port or--port port specifies the TCP port or the local socket file extension on which the server is listening for connections. Defaults to port 5433.

Connecting-To: -q --quiet

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

-q or --quiet specifies that vsql do its work quietly. By default, it prints welcome messages and various informational output. If this option is used, none of this appears. This is useful with the -c option. Within vsql you can also set the QUIET variable to achieve the same effect.

Connecting-To: -R --record-separator

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

-R separator or --record-separator separator specifies separator as the record separator. This is equivalent to the \pset recordsep command.

Connecting-To: -S --single-line

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

-S --single-line runs in single-line mode where a newline terminates a SQL command, like the semicolon does.

Note

This mode is provided for those who insist on it, but you are not necessarily encouraged to use it, particularly if you mix SQL and meta-commands on a line. The order of execution might not always be clear to the inexperienced user.

Connecting-To: -s --single-step

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

-s --single-step runs in single-step mode for debugging scripts. Forces vsql to prompt before each statement is sent to the database and allows you to cancel execution.

Connecting-To: -T --table-attr

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

-T table-options or --table-attr table-options lets you specify options to be placed within the HTML table tag. See \pset for details.

Connecting-To: -t --tuples-only

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

-t or --tuples-only disables printing of column names, result row count footers, and so on. This is equivalent to the vsql meta-command \t.

Connecting-To: -V --version

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

-V or --version prints the vsql version and exits.

Connecting-To: -v --variable --set

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

-v assignment, --variable assignment, and --set assignment perform a variable assignment, like the vsql meta-command \set.

Note

You must separate name and value, if any, by an equals sign (=) on the command line.

To unset a variable, omit the equal sign. To set a variable without a value, use the equals sign but omit the value. Make these assignments at a very early stage of start-up, so that variables reserved for internal purposes can get overwritten later.

Connecting-To: -X --no-vsqlrc

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

-X --no-vsqlrc prevents the start-up file from being read: the system-wide vsqlrc file or the user's ~/.vsqlrc file.

Connecting-To: -x --expanded

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

-x or --expanded enables extended table formatting mode. This is equivalent to the vsql meta-command \x.

Connecting-To: --oauth_encrypt

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

This VSQL utility creates an encrypted OAuth configuration file.

Connecting-To: --config_input

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

Specify the path for the input OAuth configuration file. (default: oauth_config.txt in $HOME)

Connecting-To: --config_output

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

Specify the path for the output OAuth encrypted configuration file. (default: dbname_oauth.conf in $HOME)

Connecting-To: --access-token

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

Set the desired OAuth access token.

Connecting-To: --auth-method

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

Set the desired authentication method. ('OAuth', 'Kerberos', or 'Password'). (default: Password)

Note

    This option is case-insensitive.

Connecting-To: --I

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

Identity provider (Idp) user's password