# ODBC Configuration and Connection Parameters¶

The Snowflake ODBC driver utilizes both configuration and connection parameters. The methods for setting the parameters are different depending on the environment in which the driver is installed.

In this Topic:

## Setting Parameters in Windows¶

In Windows:

• Configuration parameters are set in the Windows registry using regedit and the following registry path:

[HKEY_LOCAL_MACHINE\SOFTWARE\Snowflake\Driver]

• Connection parameters are set in Data Source Names (DSNs):

• DSNs are typically created and edited using the Windows Data Source Administration tool.

• If you wish, the registry keys for DSNs can be edited directly in the Windows registry using regedit. The registry path to the keys is different depending on whether you’re using 64-bit and 32-bit Windows and whether you’re editing a user or system DSN:

• 64-bit Windows:

[HKEY_CURRENT_USER\SOFTWARE\ODBC\ODBC.INI\<DSN_NAME>]

[HKEY_LOCAL_MACHINE\SOFTWARE\ODBC\ODBC.INI\<DSN_NAME>]

• 32-bit Windows:

[HKEY_CURRENT_USER\SOFTWARE\WOW6432NODE\ODBC\ODBC.INI\<DSN_NAME>]

[HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432NODE\ODBC\ODBC.INI\<DSN_NAME>]


To add a connection parameter using regedit, add a new String Value, double-click on the value you created, then enter the ODBC parameter as the Value name and the parameter value as the Value data.

## Setting Parameters in macOS or Linux¶

In macOS or Linux:

• Configuration parameters are set in the configuration file (simba.snowflake.ini).

• Connection parameters are set in the data source name (DSN) file (odbc.ini).

## Configuration Parameters¶

CABundleFile

Set the location of the Certificate Authority (CA) bundle file. Must reference a file that includes a valid list of CA certificates.

For Linux, the RPM and DEB installers automatically copy the file and set this parameter.

For Mac, the PKG installer copies the file and sets this parameter.

For Windows, the MSI installer copies the file and sets this parameter.

A manual installation requires you to download the file from https://curl.haxx.se/docs/caextract.html and set the location of the file.

CURLVerboseMode

Set to true to enable cURL verbose logging. The log file snowflake_odbc_curl.dmp is created and updated. The Snowflake ODBC driver uses cURL as the HTTP and SSL library. This parameter is useful for diagnosing network issues.

DisableOCSPCheck

Set to true to disable the TLS/SSL certificate revocation status check by the Online Certificate Status Protocol (OCSP). In normal circumstances, this flag should not set. But if the OCSP availability problem persists, the application might temporarily set this parameter in order to unblock connectivity issues and remove it when the OCSP availability problem is addressed.

EnableAutoIpdByDefault

Set to false to configure the ODBC Driver to set SQL_ATTR_ENABLE_AUTO_IPD to false (which is the default value in the ODBC standard).

Otherwise, by default, the ODBC Driver sets SQL_ATTR_ENABLE_AUTO_IPD to true for compatibility with third-party tools.

This parameter was introduced in version 2.22.0 of the ODBC Driver.

EnablePidLogFileNames

Set to true to include the process ID in the name of the log file. For example, if the process ID is 7394, the log files will be named:

• snowflake_odbc_connection_7394_0.log

• snowflake_odbc_generic7394_0.log

• snowflake_odbc_curl_7394.dmp

You can set this parameter to prevent different processes from overwriting the same log files. Each process will generate its own set of log files.

By default, the value of this parameter is false.

This parameter was introduced in version 2.22.2 of the ODBC Driver.

KeepLeadingTrailingZeros

Determines how leading or trailing zeros in numbers formatted as string values are handled. By default, the parameter is set to true, which means the driver retains any leading or trailing zeros. Set the parameter to false to remove leading or trailing zeros, for example:

• 0.23 is changed to .23

• 7.00 is changed to 7

LogFileCount

Sets the maximum number of log files to keep before rotating older files to make room for new log files.

LogFileSize

Specifies the maximum size, in bytes, of a log file (default: 20971520). When a log file reaches the specified size, the ODBC driver automatically creates a new log file.

LogLevel

Specifies the level of detail logged for clients that use the ODBC driver:

• 0 = Off

• 1 = Fatal

• 2 = Error

• 3 = Warning

• 4 = Info

• 5 = Debug

• 6 = Trace

LogPath

Specifies the location of the Snowflake log files for clients that use the ODBC driver.

MapToLongVarchar

Specifies the length of a string at which to begin mapping string values to an ODBC SQL_LONGVARCHAR data type instead of the default ODBC SQL_CHAR or SQL_VARCHAR data types.

• < 0 (or unset): Maps string values in their default ODBC data types. Default = -1.

• >= 0: Specifies the maximum number of string characters to map to default ODBC string data types. All strings larger than this value are mapped to SQL_LONGVARCHAR.

You can also specify this parameter as a connection parameter. (See the instructions for setting the parameters in Windows, macOS and Linux.) If set both as a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

This parameter was introduced in version 2.24.3 of the ODBC Driver.

NoExecuteInSQLPrepare

Set to true to configure the ODBC Driver to use the standard ODBC behavior when passing DDL statements (such as CREATE and DROP) to SQLPrepare() and SQLExecute().

In Snowflake, by default, when you pass a DDL statement to SQLPrepare(), the ODBC Driver sends the statement to the data source for execution (not preparation). When you pass a DDL statement to SQLExecute(), the ODBC Driver does not send the statement to the data source.

If you set NoExecuteInSQLPrepare to true, the ODBC Driver follows the standard ODBC behavior. Calling SQLPrepare() sends the statement to the data source for preparation (not execution). Calling SQLExecute() sends the statement to the data source for execution.

This parameter was introduced in version 2.21.6 of the ODBC Driver.

NoProxy

Specifies the hostname patterns to bypass the proxy server (e.g. .amazonaws.com to bypass Amazon S3 access).

Note

The Snowflake ODBC driver passes the NoProxy value to the curl option CURLOPT_NOPROXY. The format of the NoProxy value can be found here.

Proxy

Specifies a proxy server in the form of <host>:<port> for clients that use the ODBC driver.

Note

In Windows, entries for LogLevel and LogPath are created and populated with default values when the ODBC driver is installed; however, an entry for Proxy is not created during install. To specify a proxy to use with the driver, you must manually add the entry to the driver registry key.

To bypass the proxy for one or more IP addresses or URLs, add the NoProxy parameter.

## Connection Parameters¶

### Required Connection Parameters¶

<name> (Data Source)

Specifies the name of your DSN.

port (Port)

Specifies the port on which the driver listens for Snowflake communication.

Note

You do not need to change the default Port value of 443.

pwd (Password)

A password is required to connect to Snowflake; however, for security and authentication reasons, Snowflake strongly discourages storing password credentials directly within any DSN definition.

Typically, the credentials are passed to the driver programmatically by the client application that is attempting to connect to Snowflake.

Note

In Windows, the ODBC driver displays a Password field in the Data Source Administration tool; however, the driver does not store any values entered in the field. Instead, the driver requires login credentials to be provided at connection time.

server (Server)

Specifies the hostname for your account in the following format:

account_identifier.snowflakecomputing.com

For information about account identifiers, see Account Identifiers.

uid (User)

Specifies the login name of the Snowflake user to authenticate.

### Optional Connection Parameters¶

database (Database)

Specifies the default database to use for sessions initiated by the driver.

role (Role)

Specifies the default role to use for sessions initiated by the driver. The specified role should be a role that has been assigned to the specified user for the driver. If the specified role does not match any of the roles assigned to the user, sessions initiated by the driver have no role initially; however, a role can always be specified from within the session.

schema (Schema)

Specifies the default schema to use for sessions initiated by the driver.

Default is public.

tracing (Tracing)

The level of detail to be logged in the driver trace files:

• 0 = Disable tracing

• 1 = Fatal only error tracing

• 2 = Error tracing

• 3 = Warning tracing

• 4 = Info tracing

• 5 = Debug tracing

• 6 = Detailed tracing

warehouse (Warehouse)

Specifies the default warehouse to use for sessions initiated by the driver.

Note

In Windows, these additional connection parameters can be set in the Windows Registry (by using regedit).

In macOS or Linux, they are set in the odbc.ini file, similar to the rest of the connection parameters.

application

Snowflake partner use only: Specifies the name of a partner application to connect through ODBC.

This parameter can also be set by calling the SQLSetConnectAttr() function. For more details, see Snowflake-specific behavior of the SQLSetConnectAttr function.

authenticator

Specifies the authenticator to use for verifying user login credentials:

• snowflake (Default) to use the internal Snowflake authenticator.

• externalbrowser to use your web browser to authenticate with Okta, ADFS, or any other SAML 2.0-compliant identity provider (IdP) that has been defined for your account.

• https://<okta_account_name>.okta.com (i.e. the URL endpoint for your Okta account) to authenticate through native Okta (only supported if your IdP is Okta).

• oauth to authenticate using OAuth. When OAuth is specified as the authenticator, you must also set the token parameter to specify the OAuth token (see below).

• username_password_mfa to authenticate with MFA token caching. For more details, see Using Multi-Factor Authentication (in this topic).

Default is snowflake.

On Windows, you can use the ODBC Data Source Administration Tool to set this parameter.

For more information on authentication, see Managing/Using Federated Authentication and OAuth with Clients, Drivers, and Connectors.

default_binary_size, . default_varchar_size

Specifies the default size, in bytes, that the driver uses when retrieving and converting values from BINARY or VARCHAR columns of undetermined sizes. Set this when retrieving values from these types of columns.

By default, the driver uses 8388608 (for BINARY columns) and 16777216 (for VARCHAR columns) as the default sizes when allocating memory for retrieving the value of a column of undetermined size.

To reduce the amount of memory allocated for these values, you can set default_binary_size and default_varchar_size to the maximum size of the values in these types of columns.

Note

Setting these values only changes the SQL_DESC_LENGTH field in Implementation Row Descriptor (IRD) and the corresponding values returned from SQLDescribeCol/SQLColAttribute/SQLColAttributes. The driver still returns the entire data even when it’s length exceeds the setting.

On the other hand, an application could allocate a data buffer based on the length specified in these parameters that could truncate the data due to not enough space in the buffer. As the best practice, Snowflake recommends settting the default size larger than the maximum size of the typical data (e.g. 4000 or 8000 bytes) to reduce the memory usage significantly from the original default values of 16777216/8388608 bytes and to minimize the chance of data truncation.

Note that you can also use these settings to avoid the following error, which can occur when using the Microsoft OLE DB provider (MSDASQL) with a Snowflake database:

Requested conversion is not supported
Cannot get the current row value of column


You can specify these parameters as connection configuration parameters (for example, in the simba.snowflake.ini on macOS and Linux). If this is set as both a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

These parameters were introduced in version 2.23.2 of the ODBC Driver.

login_timeout

Specifies how long to wait for a response when connecting to the Snowflake service before returning a login failure error.

Default is 60 seconds.

network_timeout

Specifies how long to wait for a response when interacting with the Snowflake service before returning an error. Zero (0) indicates no network timeout is set.

Default is 0 seconds.

no_proxy

Specifies which hostname endings should be allowed to bypass the proxy server (e.g. no_proxy=.amazonaws.com means that Amazon S3 access does not need to go through the proxy).

This parameter does not support wildcards. Each value specified should be one of the following:

• The end of a hostname (or a complete hostname), for example:

• .amazonaws.com

• myorganization-myaccount.snowflakecomputing.com

• An IP address, for example:

• 192.196.1.15

If more than one value is specified, values should be separated by commas, for example:

no_proxy=localhost,.my_company.com,myorganization-myaccount.snowflakecomputing.com,192.168.1.15,192.168.1.16


Note

This parameter is applied to the process. If another connection shares the same process, the proxy setting must be identical or the behavior is not predictable.

odbc_use_standard_timestamp_columnsize

This boolean parameter affects the column size (in characters) returned for SQL_TYPE_TIMESTAMP. When this parameter is set to true, the driver returns 29, following the ODBC standard. When this parameter is set to false, the driver returns 35, which allows room for the timezone offset (e.g. “-08:00”).

This value can be set via not only the odbc.ini file (Linux or macOS) or the Microsoft Windows registry, but also the connection string.

Default is false.

passcode

Specifies the passcode to use for multi-factor authentication.

passcodeInPassword

Specifies whether the passcode for multi-factor authentication is appended to the password:

• on (or true) specifies the passcode is appended.

• off (or false) or any other value specifies the passcode is not appended.

The default value is off.

proxy

Specifies the proxy server URL in the format http://<hostname>:<port>/ or <hostname>:<port_number> so that all communications from ODBC use the proxy server.

Note

This parameter is applied to the process. If another connection shares the same process, the proxy setting must be identical or the behavior is not predictable.

put_compresslv

Specifies the compression rate the ODBC driver uses when transferring data. This parameter overrides the default gzip compression level. If you do not specify put_compresslv the ODBC driver uses the default compression level.

Valid values are -1 to 9. The default value is -1 and specifies the default Z_DEFAULT_COMPRESSION.

Values 0 through 9 specify a custom compression rate. 0 causes the ODBC driver to use a lower compression rate and 9 uses a higher compression rate. Using a higher compression rate results in slower data transfer speeds.

You can also specify this parameter as a configuration parameter (for example, in the simba.snowflake.ini on macOS and Linux). If this is set as both a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

This parameter was introduced in version 2.23.3 of the ODBC Driver.

put_fastfail

If you are using wildcard characters with the PUT command to upload multiple files at once and you want the driver to stop uploading the files when an error occurs, set this parameter to true.

The default value is false, which means that if an error occurs with one file, the driver continues uploading the rest of the files.

This parameter was introduced in version 2.22.3 of the ODBC Driver.

As of version 2.22.5 of the ODBC Driver, you can also specify this parameter as a configuration parameter (for example, in the simba.snowflake.ini on macOS and Linux). If this is set as both a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

put_maxretries

Specifies the number of times that the driver should retry the PUT command if the command fails.

The default value is 5.

The valid range of values for this parameter is 0 to 100. If you specify a value outside this range, the driver uses the default value of 5.

This parameter was introduced in version 2.22.3 of the ODBC Driver.

As of version 2.22.5 of the ODBC Driver, you can also specify this parameter as a configuration parameter (for example, in the simba.snowflake.ini on macOS and Linux). If this is set as both a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

put_tempdir

Specifies the temporary directory to use for PUT command requests. The driver uses this temporary directory to create temporary compressed files before uploading those files to Snowflake.

If this parameter is not set, the driver creates and uses the temporary directory /tmp/snowflakeTmp_username, where username is the username of the current user in the operating system.

You can also specify this parameter as a configuration parameter (for example, in the simba.snowflake.ini on macOS and Linux). If this is set as both a connection parameter and a configuration parameter, the connection parameter in the DSN (or connection string) takes precedence.

This parameter was introduced in version 2.23.1 of the ODBC Driver.

query_timeout

Specifies how long to wait for a query to complete before returning an error. Zero (0) indicates to wait indefinitely.

Default is 0 seconds.

token=<string>

Specifies the OAuth token to use for authentication, where <string> is the token. This parameter is required only when the authenticator=oauth parameter is set.

Default is none.

validateSessionParam

Specifies how to respond when any of the following session connection parameters are invalid:

• database
• schema
• warehouse

Possible values include:

• false (default): Successfully connects, but sets the database and schema parameter values to empty strings and sets the warehouse parameter to its default value. For more information about warehouses, see Warehouse Usage in Sessions .

• true: Rejects the connection and throws an error.

## Verifying the Network Connection to Snowflake with SnowCD¶

After configuring your driver, you can evaluate and troubleshoot your network connectivity to Snowflake using SnowCD.

You can use SnowCD during the initial configuration process and on-demand at any time to evaluate and troubleshoot your network connection to Snowflake.

## Connecting Through a Proxy Server¶

The instructions for configuring a proxy server connection depend on your operating system and driver version:

Operating System

Driver Version

Supported Instructions

Linux

2.16.0 (released May 3, 2018) or higher

2.13.18 (released February 7, 2018) - 2.15.0 (released April 30, 2018)

Using Environment Variables

2.13.17 or lower

Using Configuration Parameters

macOS

2.16.0 (released May 3, 2018) or higher

2.14.0 (released March 28, 2018) - 2.15.0 (released April 30, 2018)

Using Environment Variables

2.13.21 or lower

Using Configuration Parameters

Windows

2.16.0 (released May 3, 2018) or higher

2.15.0 (released April 30, 2018)

Using Environment Variables

2.14.0 or lower

Using Configuration Parameters

Note

The latest versions of ODBC driver, indicated above, support any of the listed configuration options. The options are listed in the order of precedence. If more than one option is defined, the setting with the highest precedence is applied.

### Using Connection Parameters¶

To connect through a proxy server, add the following connection parameters to the DSN:

• proxy

• no_proxy

For example:

[connection]
Description = SnowflakeDB
Driver      = SnowflakeDSIIDriver
Locale      = en-US
server      = myorganization-myaccount.snowflakecomputing.com
proxy       = http://proxyserver.company:80
no_proxy    = .amazonaws.com


See Connection Parameters for parameter descriptions.

### Using Configuration Parameters¶

Note

These parameters are obsoleted (i.e. no longer supported) in recent ODBC driver versions. See the table of supported options in Connecting Through a Proxy Server. As you upgrade your driver, configure your proxy server settings using the environment variables or connection parameters.

To connect through a proxy server, add the following configuration parameters:

• Proxy

• NoProxy

See Configuration Parameters for parameter descriptions.

### Using Environment Variables¶

To connect through a proxy server, configure the following environment variables:

• http_proxy

• https_proxy

• no_proxy

Note

These environment variables are case-sensitive for Linux and macOS, and must be set in lowercase. For Windows, the environment variables are case-insensitive.

For example:

• Linux or macOS:

export http_proxy=http://proxyserver.company.com:80
export https_proxy=http://proxyserver.company.com:80


If the proxy server requires a user name and password, include the credentials, for example:

export https_proxy=http://username:password@proxyserver.company.com:80

• Windows:

set http_proxy=http://proxyserver.company.com:80
set https_proxy=http://proxyserver.company.com:80


If the proxy server requires a user name and password, include the credentials, for example:

set https_proxy=http://username:password@proxyserver.company.com:80


Optionally, you can set no_proxy to bypass the proxy for specific communications (e.g. no_proxy=.amazonaws.com to bypass Amazon S3 access).

## Using Single Sign-on (SSO) For Authentication¶

If you have configured Snowflake to use single sign-on (SSO), you can configure your client application to use SSO for authentication. See Using SSO with Client Applications That Connect to Snowflake for details.

## Using Multi-Factor Authentication¶

Snowflake supports caching MFA tokens, including combining MFA token caching with SSO.

For more information, see Using MFA Token Caching to Minimize the Number of Prompts During Authentication — Optional.

## Using Key Pair Authentication¶

The ODBC driver supports key pair authentication and key rotation.

1. To start, complete the initial configuration for key pair authentication as shown in Key Pair Authentication & Key Pair Rotation.

2. Modify the data source name (DSN) entries for the driver. For information about the DSN entries, see the appropriate topic for your operating system:

AUTHENTICATOR = SNOWFLAKE_JWT

Specifies to authenticate the Snowflake connection using key pair authentication with JSON Web Token (JWT).

JWT_TIME_OUT = integer

Optional. Specifies the length of time Snowflake waits to receive the JWT (in seconds) before timing out. If that happens, authentication fails and the driver returns an Invalid JWT token error. To resolve repeated occurrences of the error, increase the parameter value. Default: 30

PRIV_KEY_FILE = path/rsa_key.p8

Specifies the local path to the private key file you created (i.e. rsa_key.p8).

The value set in DSN can be overridden by calling the SQLSetConnectAttr() function. For more details, see Snowflake-specific behavior of the SQLSetConnectAttr function.

PRIV_KEY_FILE_PWD = <password>

Specifies the passcode to decode the private key file.

This parameter should be set only if the parameter PRIV_KEY_FILE is also set.

The value set in DSN can be overridden by calling the SQLSetConnectAttr() function. For more details, see Snowflake-specific behavior of the SQLSetConnectAttr function.

3. Save the settings.

## Managing Log Files¶

To help you to track issues that might arise, you can enable logging in the ODBC driver. The ODBC driver provides the following configuration options that you can use to set up logging and manage log files:

You can use these parameters to manage how you name, store, and rotate log files. You can specify how large and how many log files you want to keep before replacing them with newly-created log files. The following example appends the process ID to file names to ensure uniqueness, sets the maximum file size to 30MB, and keeps the 100 most recent log files.

EnablePidLogFileNames = true  # Appends the process ID to each log file
LogFileSize = 30,145,728      # Sets log files size to 30MB
LogFileCount = 100            # Saves the 100 most recent log files


## Verifying the OCSP Connector or Driver Version¶

Snowflake uses OCSP to evaluate the certificate chain when making a connection to Snowflake. The driver or connector version and its configuration both determine the OCSP behavior. For more information about the driver or connector version, their configuration, and OCSP behavior, see OCSP Configuration.

## OCSP Response Cache Server¶

Note

The OCSP response cache server is currently supported by the Snowflake ODBC Driver 2.15.0 and higher.

Snowflake clients initiate every connection to a Snowflake service endpoint with a “handshake” that establishes a secure connection before actually transferring data. As part of the handshake, a client authenticates the TLS/SSL certificate for the service endpoint. The revocation status of the certificate is checked by sending a client certificate request to one of the OCSP (Online Certificate Status Protocol) servers for the CA (certificate authority).

A connection failure occurs when the response from the OCSP server is delayed beyond a reasonable time. The following caches persist the revocation status, helping alleviate these issues:

• Memory cache, which persists for the life of the process.

• File cache, which persists until the cache directory (e.g. ~/.cache/snowflake or ~/.snowsql/ocsp_response_cache) is purged.

• Snowflake OCSP response cache server, which fetches OCSP responses from the CA’s OCSP servers hourly and stores them for 24 hours. Clients can then request the validation status of a given Snowflake certificate from this server cache.

Important

If your server policy denies access to most or all external IP addresses and web sites, you must whitelist the cache server address to allow normal service operation. The cache server hostname is ocsp*.snowflakecomputing.com:80.

If you need to disable the cache server for any reason, set the SF_OCSP_RESPONSE_CACHE_SERVER_ENABLED environment variable to false. Note that the value is case-sensitive and must be in lowercase.

If none of the cache layers contain the OCSP response, the client then attempts to fetch the validation status directly from the OCSP server for the CA.