Installing the vsql client

This page covers a non-FIPS installation.

This page covers a non-FIPS installation. To install on a FIPS-compliant system, see Installing the FIPS client driver for ODBC and vsql.

Linux and macOS

Note

For Linux: The vsql client is automatically installed as part of the Vertica server .rpm.

To install vsql manually on another system:

Download vsql.
Extract or install vsql:
- If you downloaded the .tar, create the /opt/vertica/ directory if it does not already exist, copy the .tar to it, navigate to it, and extract the .tar:
```
$ mkdir -p /opt/vertica/
$ cp driver_name.tar.gz /opt/vertica/
$ tar vzxf driver_name.tar.gz
```
- If you downloaded the .rpm, install it with:
```
$ rpm -Uvh driver_name.rpm
```
Optionally add the vsql directory to your PATH. For example:
```
$ export PATH=$PATH:\opt\vertica\bin
```
Make the vsql client executable. For example, to allow all users to run vsql:
```
$ chmod ugo+x /path/to/vsql
```
Set your shell locale to a locale supported by vsql (which ones?). For example, in your .profile, add:
```
export LANG=end_US.UTF-8
```

Windows

To install the vsql client:

Download the Windows client driver installer. For details on the drivers included in this installer, see Windows client driver installer.
Run the installer and follow the prompts to install the drivers.
Reboot your system.

After installing the driver, you can optionally add the vsql directory to your PATH. For example, to append the vsql directory to your PATH with Windows PowerShell for the current session:

PS C:\> $Env:PATH += ";C:\Program Files\Vertica Systems\VSQL64\"

You can verify that the vsql directory is in your PATH by running vsql -?:

PS C:\> vsql -?
This is vsql, the Vertica Analytic Database interactive terminal.

Usage:
  vsql [OPTIONS]... [DBNAME [USERNAME]]

For usage details, see vsql usage on Windows