Installing the ODBC client driver

To install ODBC, follow the instructions according to your platform.

To install ODBC, follow the instructions according to your platform. For a list of supported platforms, see Client drivers support.

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

Installing on Linux

Installing Vertica from the RPM automatically installs the ODBC client driver, so you do not need to install them again on the machine running Vertica. To use the ODBC client driver in this case, create a DSN.

To install the ODBC client driver manually on other machines:

Log in to the client system as root.
Verify that your system has a supported ODBC driver manager.
Download the ODBC client driver for Linux in the format appropriate for your distribution.
Install or extract the driver:
- If you downloaded the .rpm, install the driver:
  
  Note
  If the client driver is already installed on your system (either from a manual installation or from automatic installation from the Vertica RPM) and you attempt to reinstall them manually, you will receive error messages. To bypass these errors and overwrite the existing driver installations, use the --force flag.
```
$ rpm -Uvh driver_name.rpm
```
- 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
```
  This creates two directories:
  - /opt/vertica/include: Contains the header file.
  - /opt/vertica/lib64/ (64-bit) or /opt/vertica/lib/ (32-bit): Contains library files.
Set the following ODBC driver settings in vertica.ini. For details on each, see ODBC driver settings:
- ErrorMessagesPath: Required, the path of the directory containing the ODBC driver's error message files.
- ODBCInstLib: The path to the ODBC installer library. This is only required if the driver manager's installation library is not in the environment variables LD_LIBRARY_PATH or LIB_PATH.
- DriverManagerEncoding: The UTF encoding standard used by the driver manager. This is only required if your driver manager does not use UTF-8.
The following is an example configuration in vertica.ini:
- Use encoding for the 64-bit UNIXODBC driver manager.
- Use the error messages defined in the standard Vertica 64-bit ODBC driver installation directory.
- Log all warnings and more severe messages to log files in /tmp/
```
[Driver]
DriverManagerEncoding=UTF-16
ODBCInstLib=/usr/lib64/libodbcinst.so
ErrorMessagesPath=/opt/vertica
LogLevel=4
LogPath=/tmp
```
Create a DSN.

Installing on macOS

Note

You can only have one installation per version of the ODBC driver on a macOS system. This is because each installation is identified by a package ID and version number, and package ID does not change between versions of the driver.

To install the ODBC client driver on macOS:

Verify that your system has a compatible driver manager. The driver is designed to be used with the standard iODBC Driver Manager that ships with macOS. You can also use unixODBC.
Download the ODBC client driver.
If you installed a previous version of the ODBC driver, your system might already have a registered driver named "Vertica". You must remove or rename this older version of the driver before installing a new version from the .pkg installer. Renaming the older version allows you to retain the old version after you install the new one.
Run the installer.
Create a DSN.

Installing silently

Log into the client macOS in one of two ways:
- As an administrator account if you are installing the driver for system-wide use.
- As the user who needs to use the Vertica ODBC driver.
Open a terminal.

Install the .pkg file containing the ODBC driver using the command:

sudo installer -pkg path/to/client/driver/vertica-odbc-xx.x.x-x.pkg -target /

Installing on Windows

To install the ODBC client driver on Windows:

Download the client driver installer for Windows.
Run the installer.
Create a DSN.

Installing silently

Open a terminal as an Administrator.
Run the following command to silently install the drivers to C:\Program Files\Vertica Systems:
```
VerticaSetup.exe -q -install InstallFolder="C:\Program Files\Vertica Systems"
```