Go Snowflake Driver

In v2, the global MaxChunkDownloadWorkers variable has been removed. Instead, configure the number of download workers using the Snowflake session parameter CLIENT_PREFETCH_THREADS. The default is 4.

ALTER SESSION SET CLIENT_PREFETCH_THREADS = 10

To install the Go Snowflake Driver v2, ensure you have Go 1.24 or higher installed. Initialize your Go module and then fetch the driver using go get.

Prerequisites:

• Go 1.24 or higher
• Supported OS: 64-bit Linux, Mac, or Windows

Note: This driver does not currently support GCP regional endpoints.

go mod init example.com/snowflake
go get -u github.com/snowflakedb/gosnowflake/v2

The driver supports two primary OAuth2 flows:

1. Authorization Code Flow (AuthTypeOAuthAuthorizationCode): A browser-based flow typically used for interactive user login.
2. Client Credentials Flow (AuthTypeOAuthClientCredentials): A non-interactive flow used for machine-to-machine authentication.

When using these flows, the driver can manage token refreshing. If a token expires, the driver attempts to use a refresh token to obtain a new access token before failing the authentication request.

While many internal status constants are deprecated, the driver uses them to interpret the state of a query. Common states include:

• RUNNING: The query is currently executing.
• SUCCESS: The query completed successfully.
• FAILED_WITH_ERROR: The query failed due to a specific error.
• QUEUED: The query is waiting in the queue.
• BLOCKED: The statement is waiting on a lock on a resource held by another statement.
• RESUMING_WAREHOUSE: The query is waiting for a warehouse to resume.

The gosnowflake driver supports two OCSP (Online Certificate Status Protocol) fail modes to handle situations where the OCSP responder is unreachable:

1. Fail-Open (OCSPFailOpenTrue): If the OCSP check fails (e.g., network error, timeout), the driver assumes the certificate is valid and proceeds with the connection. This is the default behavior.
2. Fail-Closed (OCSPFailOpenFalse): If the OCSP check fails, the driver treats the certificate as potentially revoked and terminates the connection.

Note: The OCSPFailOpenMode type is currently deprecated and will be moved to Config/DSN in future releases. Use the constants OCSPFailOpenTrue and OCSPFailOpenFalse to set this value.

// Example of the intended usage (conceptually, as it moves to Config/DSN)
// mode := gosnowflake.OCSPFailOpenFalse

To use JWT (JSON Web Token) authentication, you must provide a PrivateKey in your driver configuration. The driver will automatically generate a JWT with the following claims:

• iss: {account_name}.{user_name}.SHA256:{base64_encoded_public_key_hash}
• sub: {account_name}.{user_name}
• iat: Issued at time (UTC)
• nbf: Not before (fixed to 2015-10-10)
• exp: Expiration time based on your JWTExpireTimeout configuration.

Ensure the PrivateKey is valid and the Account and User fields are correctly populated in your Config object.

By default, the driver registers itself with sql.Register("snowflake", &SnowflakeDriver{}) during init().

If you need to call multiple versions of the driver within a single client, you can set the environment variable GOSNOWFLAKE_SKIP_REGISTRATION to prevent the driver from registering automatically. This avoids panics caused by registering the same driver name multiple times.

Note: If you use sql.Open(), you must not use this environment variable, as sql.Open requires the driver to be registered to map the name "snowflake" to the driver type.

# Set this to avoid registration panics when using multiple driver versions
export GOSNOWFLAKE_SKIP_REGISTRATION=true

The gosnowflake.Config struct is used to manage connection settings. Note the following changes in v2:

• ServerSessionKeepAlive: Replaces KeepSessionAlive.
• DisableOCSPChecks: Replaces InsecureMode.
• Transporter: Use this field to provide a custom transport (replaces the global SnowflakeTransport).
• TLSConfigName: Use this to reference a custom TLS configuration registered via RegisterTLSConfig.

import "crypto/tls"

// Custom Transport
config := &gosnowflake.Config{
    Transporter: yourCustomTransport,
}

// Custom TLS
tlsConfig := &tls.Config{
    // ...
}
_ = gosnowflake.RegisterTLSConfig("custom", tlsConfig)
config.TLSConfigName = "custom"