Linux uses named data sources (DSNs) for connecting ODBC-based client applications to Snowflake. You can choose to install the ODBC driver using the TGZ file, RPM package, or DEB package provided in the Snowflake Client Repository.
Prerequisites¶ Operating system¶For a list of the operating systems supported by Snowflake clients, see Operating system support.
With ODBC version 3.0.1, the driver no longer supports CentOS 6 versions.
Driver manager: iODBC or unixODBC¶A driver manager is required to manage communication between Snowflake and the ODBC driver. The driver supports using either iODBC or unixODBC as the driver manager.
iODBC¶If iODBC is not installed on CentOS, as sudo
, execute the following command:
unixODBC provides the odbcinst
and isql
command line utilities used to install, configure, and test the driver. To verify whether unixODBC is installed, execute the following commands:
which odbcinst which isql
Copy
If unixODBC is not installed:
As sudo
, execute the following commands:
yum search unixODBC yum install unixODBC.x86_64Copy
Verify the directory where odbcinst
expects the odbcinst.ini
and odbc.ini
files to be located:
The location should be /etc
.
Note
If you are installing the ODBC driver by using yum
or the TGZ file, skip this step.
If you are installing the ODBC driver using the RPM or DEB package and wish to verify the package signature before installation, perform the following tasks:
1.1: Download and import the latest Snowflake public key¶From the public keyserver, download and import the Snowflake GPG public key for the version of the ODBC driver that you are using:
For version 3.6.0 and higher:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 2A3149C82551A34A
For version 3.5.0:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 5A125630709DD64B
For version 2.25.6 through 3.4.1:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 630D9F3CAB551AF3
For version 2.22.1 through 2.25.5:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 37C7086698CB005C
For version 2.18.2 through 2.22.0:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys EC218558EABB25A1
For version 2.18.1 and lower:
$ gpg --keyserver hkp://keyserver.ubuntu.com --recv-keys 93DB296A69BE019A
Note
If this command fails with the following error:
gpg: keyserver receive failed: Server indicated a failureCopy
then specify that you want to use port 80 for the keyserver:
1.2: Download the RPM or DEB driver package¶gpg --keyserver hkp://keyserver.ubuntu.com:80 ...Copy
Download the package from the Snowflake Client Repository. For details, see Downloading the ODBC Driver.
1.3: Verify the signature for the RPM or DEB driver package¶ RPM package signature¶Verify the key was imported successfully:
The command should display the Snowflake key.
Verify the signature:
rpm -K snowflake-odbc-<version>.x86_64.rpmCopy
Note
If rpm
does not have the GPG key that you imported, the command will report that the signatures are not OK and will produce a NOKEY
warning:
rpm -K snowflake-odbc-<version>.x86_64.rpmCopy
snowflake-odbc-<version>.x86_64.rpm: digests SIGNATURES NOT OK rpm -Kv snowflake-odbc-<version>.x86_64.rpmsnowflake-odbc-<version>.rpm: Header V4 RSA/SHA1 Signature, key ID 98cb005c: NOKEY Header SHA1 digest: OK V4 RSA/SHA1 Signature, key ID 98cb005c: NOKEY MD5 digest: OK
If this occurs, run the following commands to export the GPG key, import the key into rpm
, and verify the signature again:
gpg --export -a <GPG_KEY_ID> > odbc-signing-key.asc sudo rpm --import odbc-signing-key.asc rpm -K snowflake-odbc-<version>.x86_64.rpmCopy
where <GPG_KEY_ID>
is the ID for the key that you installed in 1.1: Download and import the latest Snowflake public key.
Install the package signature verification tool:
sudo apt-get install debsig-verifyCopy
Import the public key to the keyring:
mkdir /usr/share/debsig/keyrings/<GPG_KEY_ID> gpg --export <GPG_KEY_ID> > snowflakeKey.asc touch /usr/share/debsig/keyrings/<GPG_KEY_ID>/debsig.gpg gpg --no-default-keyring --keyring /usr/share/debsig/keyrings/<GPG_KEY_ID>/debsig.gpg --import snowflakeKey.ascCopy
where <GPG_KEY_ID>
is the ID for the key that you installed in 1.1: Download and import the latest Snowflake public key.
Configure a policy for the key. For details, see /usr/share/doc/debsig-verify
. The policy must be stored in the following directory:
/etc/debsig/policies/<GPG_KEY_ID>Copy
where <GPG_KEY_ID>
is the ID for the key that you installed in 1.1: Download and import the latest Snowflake public key.
Store the policy in a file named policy_name.pol
, where policy_name
is your name for the policy. For the policy name, you can use any text string, however the string cannot contain blank spaces.
Here is a sample policy file for a key with the ID 2A3149C82551A34A:
<?xml version="1.0"?> <!DOCTYPE Policy SYSTEM "http://www.debian.org/debsig/1.0/policy.dtd"> <Policy xmlns="https://www.debian.org/debsig/1.0/"> <Origin Name="Snowflake Computing" id="2A3149C82551A34A" Description="Snowflake ODBC Driver DEB package"/> <Selection> <Required Type="origin" File="debsig.gpg" id="2A3149C82551A34A"/> </Selection> <Verification MinOptional="0"> <Required Type="origin" File="debsig.gpg" id="2A3149C82551A34A"/> </Verification> </Policy>
Verify the signature:
sudo debsig-verify snowflake-odbc-<version>.x86_64.debCopy
Note
By default, the dpkg package signature verification tool does not check the signature when you install the package. If you want to verify the signature every time you run dpkg, remove the --no-debsig
line in the /etc/dpkg/dpkg.cfg
file.
Your local environment can contain multiple GPG keys; however, for security reasons, Snowflake periodically rotates the public GPG key. As a best practice, we recommend deleting the existing public key after confirming that the latest key works with the latest signed package.
To delete the key:
Step 2: Install the ODBC Driver¶gpg --delete-key "Snowflake Computing"Copy
Install the driver using one of the following approaches:
Using yum to download and install the driver¶With version 2.21.1 of the ODBC Driver (and later versions), you can use yum
to download and install the driver.
To download and install the Snowflake ODBC driver for Linux using yum
:
Create a file named /etc/yum.repos.d/snowflake-odbc.repo
, and add the following text to the file:
[snowflake-odbc] name=snowflake-odbc baseurl=https://sfc-repo.snowflakecomputing.com/odbc/linux/<VERSION_NUMBER>/ gpgkey=https://sfc-repo.snowflakecomputing.com/odbc/Snowkey-<GPG_KEY_ID>-gpg
Copy
where VERSION_NUMBER
is the specific version number of the driver (for example, 3.11.0) and GPG_KEY_ID
is one of the following key IDs:
ODBC Driver Version
GPG Key ID
3.6.0 and higher
2A3149C82551A34A
3.5.0
5A125630709DD64B
2.25.6 through 3.4.1
630D9F3CAB551AF3
2.22.1 through 2.25.5
37C7086698CB005C
In the settings above, baseurl
and gpgkey
point to the Snowflake Client Repository on Amazon S3. If you want to use the mirror on Azure Blob instead, change the hostname to https://sfc-repo.azure.snowflakecomputing.com/
:
[snowflake-odbc] name=snowflake-odbc baseurl=https://sfc-repo.azure.snowflakecomputing.com/odbc/linux/<VERSION_NUMBER>/ gpgkey=https://sfc-repo.azure.snowflakecomputing.com/odbc/Snowkey-<GPG_KEY_ID>-gpg
Copy
Run the following command to install the driver:
yum install snowflake-odbc
Copy
To install the Snowflake ODBC driver for Linux using the TGZ file that you downloaded earlier.
Copy the downloaded file (snowflake_linux_x8664_odbc-version.tgz
) to a working directory.
Unzip the file:
gunzip snowflake_linux_x8664_odbc-<version>.tgzCopy
Extract the files from the .tar file:
tar -xvf snowflake_linux_x8664_odbc-<version>.tarCopy
Copy the resulting snowflake_odbc
folder to the directory where you want to install the driver. Make note of this directory. You’ll need the location later in the instructions.
Note
The RPM package requires unixODBC as the driver manager.
To install the Snowflake ODBC driver for Linux using the RPM package that you downloaded earlier, after optionally verifying the package signature, run the following command:
yum install snowflake-odbc-<version>.x86_64.rpmCopy
Note
The installation directory is /usr/lib64/snowflake/odbc/
. You’ll need the location later in the instructions.
If the driver cannot find the library, it displays an Unable to locate SQLGetPrivateProfileString function
error. In this case, you must set ODBCInstLib=<driver_manager_path>
manually in the simba.snowflake.ini
configuration file with the name of the driver manager on your system. For more information, see Configure the ODBC Driver.
For example, ODBCInstLib=/usr/lib/x86_64-linux-gnu/libodbcinst.so.2
.
Note
The DEB package requires unixODBC as the driver manager. Please make sure that unixodbc and odbcinst packages are installed, before attempting to install the DEB package.
To install the Snowflake ODBC driver for Linux using the DEB package that you downloaded earlier, after optionally verifying the package signature, run the following command:
sudo SF_ACCOUNT="<account>" dpkg -i snowflake-odbc-<version>.x86_64.deb
Copy
If the SF_ACCOUNT
variable is unset, the dpkg
command shows a warning. When you set the variable as shown, a Snowflake connection is added to the odbc.ini
file.
The command might fail if any required dependencies for the package manager are not installed. If that happens, install them now:
Note
The installation directory is /usr/lib/snowflake/odbc/
. You’ll need the location later in the instructions.
Note
If you installed the ODBC driver using the RPM or DEB package file, skip this step.
If you installed using the TGZ file, configure the environment using the installed driver manager (either iODBC or unixODBC).
Configuring with iODBC¶In a terminal window, change to the snowflake_odbc
directory, and run the following command to install Snowflake ODBC:
This script completes the following steps:
Adds one Snowflake connection to your system-level
/etc/odbc.ini
file.Adds the Snowflake driver information to your system-level
/etc/odbcinst.ini
file.Adds all certificate authority (CA) certificates required by the Snowflake ODBC driver to your system-level
simba.snowflake.ini
file.
By running iodbc_setup.sh
, you don’t need to set any environment variables.
Alternatively, if you don’t want Snowflake to change your system configurations, add the following environment variables to your shell configuration file (e.g. .profile
, .bash_profile
):
ODBCINI = <path>/conf/odbc.ini
ODBCINSTINI = <path>/conf/odbcinst.ini
Where path
is the location of the snowflake_odbc
directory. If you have configured other ODBC drivers in your system and plan to add the Snowflake ODBC entries to your existing odbc.ini
and odbcinst.ini
files in the next step, then point ODBCINI and ODBCINSTINI to the location of those files.
In a terminal window, change to the snowflake_odbc
directory, and run the following command to install Snowflake ODBC:
This script completes the following steps:
Adds a Snowflake connection to your system-level
/etc/odbc.ini
file.Adds the Snowflake driver information to your system-level
/etc/odbcinst.ini
file.Adds all certificate authority (CA) certificates required by the Snowflake ODBC driver to your system-level
simba.snowflake.ini
file.
By running unixodbc_setup.sh
, you don’t need to set any environment variables.
Alternatively, if you don’t want Snowflake change your system configurations, add the following environment variables to your shell configuration file, e.g. .profile
, .bash_profile
:
ODBCSYSINI = <path>/conf/
Where path
is the location of the snowflake_odbc
directory. If you have configured other ODBC drivers in your system and plan to add the Snowflake ODBC entries to your existing odbc.ini
and odbcinst.ini
files in the next step, then point ODBCSYSINI to the location of those files.
Configuring the ODBC driver requires adding entries to the following files:
<path>/lib/simba.snowflake.ini
/etc/odbcinst.ini
(or <path>/conf/odbc.ini
, if you are using environment variables)
/etc/odbc.ini
(or <path>/conf/odbcinst.ini
, if you are using environment variables)
Where path
is the location of the snowflake_odbc
directory.
simba.snowflake.ini
file (driver manager and logging)¶
Add the following entries to the simba.snowflake.ini
file:
ErrorMessagesPath=<path>/ErrorMessages/ LogPath=/tmp/ ODBCInstLib=<driver_manager_path> CABundleFile=<path>/lib/cacert.pem ANSIENCODING=UTF-8Copy
Where:
path
is the location of thesnowflake_odbc
directory.
driver_manager_path
is the location of your driver manager directory:
iODBC:
ODBCInstLib=libiodbcinst.so.2
unixODBC:
ODBCInstLib=libodbcinst.so
Note
If your driver manager directory is not included in the
LD_LIBRARY_PATH
environment variable, specify the full path to the driver manager library here.
Verify that you have write permissions on the log path.
The ANSIENCODING
parameter specifies the application’s character encoding. The default is UTF-8
. The parameter is intended for use only by Snowflake; customers should not change the value.
odbcinst.ini
file (driver registration)¶
Add the following entries to the odbcinst.ini
file:
[ODBC Drivers] SnowflakeDSIIDriver=Installed [SnowflakeDSIIDriver] APILevel=1 ConnectFunctions=YYY Description=Snowflake DSII Driver=/<path>/lib/libSnowflake.so DriverODBCVer=03.52 SQLLevel=1Copy
Where path
is the location of the snowflake_odbc
directory.
odbc.ini
file (DSN entries)¶
For each DSN, add the following entries to the odbc.ini
file:
DSN Name and driver name (SnowflakeDSIIDriver), in the form of <dsn_name> = <driver_name>
.
Parameters:
Required connection parameters, such as
server
.Any additional, optional parameters, such as default
role
,database
, andwarehouse
.
Parameters are specified in the form of <parameter_name> = <value>
. For details about the parameters that can be set for each DSN, see ODBC configuration and connection parameters.
The following example illustrates an odbc.ini
file that configures two data sources that use different forms of an account identifier in the server
URL:
testodbc1
uses the account name as an identifier for the account myaccount
in the organization myorganization
.
testodbc2
uses the account locator xy12345
as the account identifier.
Note that testodbc2
uses an account in the AWS US West (Oregon) region. If the account is in a different region or if the account uses a different cloud provider, you need to specify additional segments after the account locator.
[ODBC Data Sources] testodbc1 = SnowflakeDSIIDriver testodbc2 = SnowflakeDSIIDriver [testodbc1] Driver = /usr/jsmith/snowflake_odbc/lib/libSnowflake.so Description = server = myorganization-myaccount.snowflakecomputing.com role = sysadmin [testodbc2] Driver = /usr/jsmith/snowflake_odbc/lib/libSnowflake.so Description = server = xy12345.snowflakecomputing.com role = analyst database = sales warehouse = analysis
Copy
Note the following:
Both testodbc1
and testodbc2
have default roles.
testodbc2
also has a default database and warehouse.
Test the driver using the installed driver manager (either iODBC or unixODBC).
Testing with iODBC¶Test the DSNs you created. On the command line, specify the DSN name, user login name, and password, using the following format:
iodbctest "DSN=<dsn_name>;UID=<user_name>;PWD=<password>"
For example:
iodbctest "DSN=testodbc2;UID=mary;PWD=password"
Copy
iODBC Demonstration program This program shows an interactive SQL processor Driver Manager: 03.52.0709.0909 Driver: 2.12.70 (Snowflake) SQL>Testing with unixODBC¶
Test the DSNs you created using the isql
command line utility provided with unixODBC
.
On the command line, specify the DSN name, user login name, and password.
For example:
isql -v testodbc2 mary <password>
Copy
Dec 14 22:57:50 INFO 2022078208 Driver::LogVersions: SDK Version: 09.04.09.1013 Dec 14 22:57:50 INFO 2022078208 Driver::LogVersions: DSII Version: 2.12.36 Dec 14 22:57:50 INFO 2022078208 SFConnection::connect: Tracing level: 4 +---------------------------------------+ | Connected! | | | | sql-statement | | help [tablename] | | quit | | | +---------------------------------------+ SQL>
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4