Installing and configuring the ODBC Driver 4.x for Windows¶
Version: 4.x. Switch to ODBC 3.x · Choose another task.
Windows utilizes named data sources (DSNs) for connecting ODBC-based client applications to Snowflake.
Important
These instructions install ODBC 4.x. Installing 4.x replaces 3.x on the machine. If you currently use 3.x, read the migration guide and validate on a separate host first. To stay on 3.x, use the 3.x Windows instructions.
Prerequisites¶
Operating system¶
For a list of the operating systems supported by Snowflake clients, see Operating system support.
Administrator privileges¶
To install the ODBC driver, you need administrator-level privileges so
that the driver can be installed in the C:\Program Files directory.
Microsoft Visual C++ Redistributable¶
To use the Snowflake ODBC Driver on Windows, install the latest supported Microsoft Visual C++ v14 Redistributable for your application and driver architecture.
Step 1: Install the ODBC Driver¶
-
If you haven’t already downloaded the latest driver version, download it now. For details, see Downloading the ODBC Driver 4.x. Use
snowflake-odbc-<version>.x86_64.msi,snowflake-odbc-<version>.x86_32.msi, orsnowflake-odbc-<version>.aarch64.msito match the application architecture. -
Double-click the downloaded
.msifile.The driver is installed in
%ProgramFiles%\Snowflake ODBC Driver\.
Step 2: Configure the ODBC Driver¶
To configure the ODBC driver in a Windows environment, create a DSN for the driver:
-
Launch the Windows Data Source Administration Tool:
Search on your Windows machine for the launcher for the ODBC Data Source Administration Tool:
Once you find the ODBC administration tool, click on the tool to launch it and display the set up window.
-
Verify that the Snowflake ODBC driver is installed:
Navigate to the Drivers tab in the set up window and verify that the driver (Snowflake ODBC) appears:
If you do not see Snowflake ODBC, then the Snowflake ODBC driver installation did not complete successfully and you need to re-install it.
-
Create a new DSN:
-
Navigate to the User DSN or System DSN tab and click the Add button:
-
Select Snowflake ODBC from the list of installed drivers.
-
Enter the connection parameters for the driver.
In the fields provided in Snowflake Configuration dialog, enter the parameters for the DSN:
When entering parameters, note the following:
-
Data Source, User and Server are the only parameters required to create a DSN.
For more information on these parameters, see Required connection parameters.
-
All other parameters in the dialog are optional. In particular, the proxy-related parameters should be specified only if you are using a proxy, and the Authenticator should be changed from the default (“snowflake”) only if needed. For more details about ODBC Data Source parameters, see ODBC configuration and connection parameters and, in particular, Optional connection parameters.
-
The Password field accepts a value, but does not store the value. This is a security precaution to ensure passwords are never stored directly in the driver.
-
Version 4.x no longer shows a
Tracing(0-6)field. Configure driver logging insf.odbc.ini. See Configuration differences.
Note
-
The ODBC driver supports additional parameters that are not displayed in the dialog. These parameters can only be set in the Windows registry using regedit.
For descriptions of all the parameters, see ODBC configuration and connection parameters.
-
Specifying a value in the Authenticator field is only required if you are using federated authentication. For more information, see the
authenticatorparameter description in ODBC configuration and connection parameters.
-
-
Click OK to create the DSN.
-
You can now reference this DSN in ODBC-based client applications for connecting to Snowflake.
Configure logging¶
For ODBC 4.x, create %APPDATA%\snowflake\sf.odbc.ini for the user running the application, or set
SF_ODBC_INI to the full path of your configuration file before starting the application. %APPDATA% is the
Roaming AppData directory. Create the directory if it does not exist, and ensure the user can write to LogPath.
Do not use the 3.x driver registry key or numeric log levels for 4.x logging. See configuration differences for all supported keys and the file search order.
Step 3: Test the connection¶
Connect from the ODBC application using the DSN you configured. Use an application and driver with matching architectures. Confirm that the application reports the installed 4.x driver version. If you are migrating an existing application, continue with the migration validation steps.