Install ODBC V3 for MacOS or Linux #

The Starburst ODBC driver V3 series is described in the following pages:

• Overview
• Install ODBC V3 for Windows”
• This page — Install ODBC V3 for MacOS or Linux
• DSN configuration
• Using connection strings
• Connection string keywords
• Mapping V2 keywords
• Upgrading and rolling back
• ODBC V3 driver archive

This page provides instructions for installing the Starburst ODBC driver V3 series on the following operating systems:

• macOS installation
• Linux installation

• For installation on Windows, see Install ODBC V3 for Windows

For all supported operating systems, the Starburst ODBC V3 driver supports connecting to Starburst Galaxy and to the four most recent LTS releases of Starburst Enterprise.

macOS installation #

macOS requirements #

Before you install the driver, make sure you have the following requirements:

• MacOS 12 or newer
• Administrator rights on the target Mac
• 150 MB of available disk space
• The following ODBC driver manager installed:
  • iODBC 3.51.16 or newer

Download the driver #

Download the driver:

• Universal Intel and Apple Silicon .pkg (public preview)

See the release notes for v3.2.2.279.

Install the driver #

1. Double-click the PKG file to run the installer.
2. In the installer, click Continue.
3. On the Software License Agreement screen, click Continue, and when the prompt appears, click Agree if you agree to the terms of the License Agreement.
4. The default installation location is /Library/starburst/starburstodbc. To optionally change the location:
   • Click Change Install Location.
   • Browse to your desired folder.
   • Click Continue.
5. To accept the installation location and begin the installation, click Install.
6. When the installation completes, click Close.

Troubleshooting #

In you encounter issues during your installation:

• Verify your configuration meets all requirements.
• Contact Starburst Support.

Linux installation #

Linux requirements #

Before you install the driver, make sure you have the following requirements:

• One of the following Linux distributions:
  • Red Hat® Enterprise Linux® (RHEL) 8 or newer
  • SuSE Linux Enterprise Server (SLES) 15 SP3 or newer
  • Debian Linux 10 or newer
  • Ubuntu Linux 20.04 LTS or newer
• Root rights on the target machine
• 90 MB of available disk space
• One of the following ODBC driver managers installed:
  • iODBC 3.51.16 or newer
  • unixODBC 2.3.11 or newer

Download the driver #

Download the driver:

• RHEL x86_64/64-bit .rpm (public preview)
• Debian 64-bit .deb (public preview)

See the release notes for v3.2.2.279.

Install the driver using RPM #

1. Log in as the root user.

2. Navigate to the folder containing the RPM package for the driver.

3. Run one of the following commands from the command line, where RPM_fileName is the file name of the RPM package.

   a. For Red Hat Enterprise Linux, run:

   yum --nogpgcheck localinstall <RPM_fileName>
   

   b. For SUSE Linux Enterprise Server, run:

   zypper install <RPM_fileName>
   

   <!–

4. Next, configure environment variables on your machine to make sure that the ODBC driver manager can work with the driver. See Configure the ODBC driver manager. –>

Install the driver on Debian #

To install the ODBC driver on Debian systems, including Ubuntu, follow these steps.

1. Log in as the root user.

2. Navigate to the folder containing the DEB package for the driver.

3. Double-click the .deb installer file.

4. Follow the instructions in the installer to complete the installation process.

Troubleshooting #

In you encounter issues during your installation:

• Verify your configuration meets all requirements.
• Contact Starburst Support.

Configuration file search order #

To locate the starburst.starburstodbc.ini file, the ODBC V3 driver uses the following search order:

1. If the STARBURSTINI environment variable is defined, then the driver searches for the file specified by the environment variable.
2. The driver searches the directory that contains the driver library files for a file named starburst.starburstodbc.ini.
3. The driver searches the current working directory of the application for a file named starburst.starburstodbc.ini.
4. The driver searches the home directory for a hidden file named .starburst.starburstodbc.ini (prefixed with a period).
5. The driver searches the /etc directory for a file named starburst.starburstodbc.ini.

Driver versions #

Some client applications may require specific versions of the ODBC driver. Review your client application’s documentation for compatibility requirements.

If your client requires an older version of the ODBC driver, either:

• Use a previous release of the ODBC V3 driver.
• Contact Starburst Support for assistance.

Next steps #

After you install the ODBC driver V3 series, configure a data source name (DSN) or compose a connection string.