The connection string properties are the various options that
can be used to establish a connection. This section provides
a complete list of the options you can configure in the
connection string for this provider. Click the links for
further details.
For more information on establishing a connection, see
Basic Tab.
Authentication
| Property | Description |
| AuthScheme | The authentication scheme used.
Accepted entries are Password, OKTA,
PrivateKey, AzureAD, OAuth, or
PingFederate. |
| Account | The Account provided for
authentication with Snowflake
database. This is usually derived
from the URL automatically. |
| Warehouse | The name of the Snowflake warehouse.
|
| User | The username provided for
authentication with the Snowflake
database. |
| Password | The user's password. |
| URL | The URL of Snowflake database. |
| RoleName | The role of the Snowflake user:
PUBLIC, SYSADMIN, or ACCOUNTADMIN.
|
| CredentialsLocation | The location of the settings file
where credentials are saved. |
Connection
| Property | Description |
| UseVirtualHosting | If true (default), buckets will be
referenced in the request using the
hosted-style request:
http://yourbucket.s3.amazonaws.com/yourobject.
If set to false, the bean will use
the path-style request:
http://s3.amazonaws.com/yourbucket/yourobject.
Note that this property will be set
to false, in case of an S3 based
custom service when the CustomURL is
specified. |
Azure Authentication
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used
to access data. If not specified,
your default tentant will be used.
|
SSO
| Property | Description |
| ProofKey | The ProofKey for authentication with
Snowflake database. This is usually
derived from GetSSOAuthorizationURL
call. |
| ExternalToken | The External Token for authentication
with the Snowflake database. This is
usually derived from the external
handler. For example, handle the
callback URL from procedure
GetSSOAuthorizationURL will get this
token. |
| SSOProperties | Additional properties required to
connect to the identity provider in
a semicolon-separated list. |
KeyPairAuth
| Property | Description |
| PrivateKey | The private key provided for key pair
authentication with Snowflake. |
| PrivateKeyPassword | The password for the private key
specified in the PrivateKey
property, if required. |
| PrivateKeyType | The type of key store containing the
private key to use with key pair
authentication. |
OAuth
| Property | Description |
| InitiateOAuth | Set this property to initiate the
process to obtain or refresh the
OAuth access token when you connect.
|
| OAuthClientId | The client Id assigned when you
register your application with an
OAuth authorization server. |
| OAuthClientSecret | The client secret assigned when you
register your application with an
OAuth authorization server. |
| OAuthAccessToken | The access token for connecting using
OAuth. |
| CallbackURL | The OAuth callback URL to return to
when authenticating. This value must
match the callback URL you specify
in your Add-In settings. |
| State | An optional value that has meaning for
your OAuth App. |
| OAuthSettingsLocation | The location of the settings file
where OAuth values are saved when
InitiateOAuth is set to
GETANDREFRESH or REFRESH.
Alternatively, this can be held in
memory by specifying a value
starting with memory://. |
| OAuthAuthenticator | This determines the authenticator that
the OAuth application requests from
Snowflake. |
| Scope | This determines the scopes that the
OAuth application requests from
Snowflake. |
| OAuthAuthorizationURL | The authorization URL for the OAuth
service. |
| OAuthAccessTokenURL | The URL to retrieve the OAuth access
token from. |
| OAuthVerifier | The verifier code returned from the
OAuth authorization URL. |
| PKCEVerifier | A random value used as input for
calling GetOAuthAccessToken in the
PKCE flow. |
| OAuthRefreshToken | The OAuth refresh token for the
corresponding OAuth access token.
|
| OAuthExpiresIn | The lifetime in seconds of the OAuth
AccessToken. |
| OAuthTokenTimestamp | The Unix epoch timestamp in
milliseconds when the current Access
Token was created. |
SSL
| Property | Description |
| SSLServerCert | The certificate to be accepted from
the server when connecting using
TLS/SSL. |
Firewall
| Property | Description |
| FirewallType | The protocol used by a proxy-based
firewall. |
| FirewallServer | The name or IP address of a
proxy-based firewall. |
| FirewallPort | The TCP port for a proxy-based
firewall. |
| FirewallUser | The user name to use to authenticate
with a proxy-based firewall. |
| FirewallPassword | A password used to authenticate to a
proxy-based firewall. |
Proxy
| Property | Description |
| ProxyAutoDetect | This indicates whether to use the
system proxy settings or not. This
takes precedence over other proxy
settings, so you'll need to set
ProxyAutoDetect to FALSE in order
use custom proxy settings. |
| ProxyServer | The hostname or IP address of a proxy
to route HTTP traffic through. |
| ProxyPort | The TCP port the ProxyServer proxy is
running on. |
| ProxyAuthScheme | The authentication type to use to
authenticate to the ProxyServer
proxy. |
| ProxyUser | A user name to be used to authenticate
to the ProxyServer proxy. |
| ProxyPassword | A password to be used to authenticate
to the ProxyServer proxy. |
| ProxySSLType | The SSL type to use when connecting to
the ProxyServer proxy. |
| ProxyExceptions | A semicolon separated list of
destination hostnames or IPs that
are exempt from connecting through
the ProxyServer . |
Logging
| Property | Description |
| LogModules | Core modules to be included in the log
file. |
Schema
| Property | Description |
| Location | A path to the directory that contains
the schema files defining tables,
views, and stored procedures. |
| Database | The name of the Snowflake database.
|
| Schema | The schema of the Snowflake database.
|
Miscellaneous
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its
execution. |
| AsyncQueryTimeout | The timeout for asynchronous requests
issued by the provider to download
large result sets. |
| CustomStage | The name of a custom stage to use
during bulk write operations. |
| EnableArrow | Whether to support Apache Arrow. |
| ExternalStageAWSAccessKey | Your AWS account access key. Only used
when defining a CustomStage for bulk
write operations. |
| ExternalStageAWSSecretKey | Your AWS account secret key. Only used
when defining a CustomStage for bulk
write operations. |
| ExternalStageAzureSASToken | The string value of the Azure Blob
shared access signature. |
| IgnoreCase | Whether to ignore case in identifiers.
Default: false. |
| IncludeTableTypes | If set to true, the provider will
report the types of individual
tables and views. |
| MaxRows | Limits the number of rows returned
rows when no aggregation or group by
is used in the query. This helps
avoid performance issues at design
time. |
| MaxThreads | Specifies the number of concurrent
requests. |
| MergeDelete | A boolean indicating whether batch
DELETE statements should be
converted to MERGE statements
automatically. Only used when the
DELETE statement's where clause
contains a table's primary key field
only and they are combined with AND
logical operator. |
| MergeInsert | A boolean indicating whether INSERT
statements should be converted to
MERGE statements automatically. Only
used when the INSERT contains a
table's primary key field. |
| MergeUpdate | A boolean indicating whether batch
UPDATE statements should be
converted to MERGE statements
automatically. Only used when the
UPDATE statement's where clause
contains a table's primary key field
only and they are combined with AND
logical operator. |
| Other | These hidden properties are used only
in specific use cases. |
| Pagesize | The maximum number of results to
return per page from Snowflake. |
| Readonly | You can use this property to enforce
read-only access to Snowflake from
the provider. |
| ReplaceInvalidUTF8Chars | Specifies whether to repalce invalid
UTF8 characters with a '?'. |
| RetryOnS3Timeout | Whether or not to retry when network
issues occur at during chunk
downloading. |
| SessionParameters | The session parameters for Snowflake.
For example:
SessionParameters='QUERY_TAG=MyTag;QUOTED_IDENTIFIERS_IGNORE_CASE=True;';.
|
| Timeout | The value in seconds until the timeout
error is thrown, canceling the
operation. |
| UseAsyncQuery | This field sets whether async query is
enabled. |