Connection String Parameters for Snowflake
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.
Name | Description |
Account | The Account provided for authentication with Snowflake database. This is usually derived from the URL automatically. |
AsyncQueryTimeout | The timeout for asynchronous requests issued by the provider to download large result sets. |
AuthScheme | The authentication scheme used. Accepted entries are PASSWORD, OKTA, PRIVATEKEY or AzureAD. |
AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
CacheConnection | The connection string for the cache database. This property is always used in conjunction with CacheProvider . Setting both properties will override the value set for CacheLocation for caching data. |
CacheLocation | Specifies the path to the cache when caching to a file. |
CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
CacheProvider | The name of the provider to be used to cache data. |
CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
ConnectionLifeTime | The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed. |
Database | The name of the Snowflake database. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
IgnoreCase | Whether to ignore case in identifiers. Default: false. |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Logfile | A path to the log file. |
MaxLogFileCount | A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted. |
MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end. |
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. |
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. |
MFAPasscode | Specifies the passcode to use for multi-factor authentication. |
Offline | Use offline mode to get the data from the cache instead of the live source. |
Other | These hidden properties are used only in specific use cases. |
ParallelLevel | The maximum number of thread which executing the select statement. |
Password | The user's password. |
PoolIdleTimeout | The allowed idle time for a connection before it is closed. |
PoolMaxSize | The maximum connections in the pool. |
PoolMinSize | The minimum number of connections in the pool. |
PoolWaitTime | The max seconds to wait for an available connection. |
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. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
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. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryPassthrough | This option passes the query to the Snowflake server as is. |
Readonly | You can use this property to enforce read-only access to Snowflake from the provider. |
RoleName | The role of the Snowflake user: PUBLIC, SYSADMIN, or ACCOUNTADMIN. |
RTK | The runtime key used for licensing. |
Schema | The schema of the Snowflake database. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSOIDP | The URL endpoint for SAML requests. |
SupportEnhancedSQL | If the property is set to true, allow the provider to perform queries client-side when Snowflake does not support them. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Timeout | A timeout for the provider. |
Url | The URL of Snowflake database. |
UseConnectionPooling | This property enables connection pooling. |
User | The username provided for authentication with the Snowflake database. |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
Warehouse | The name of the Snowflake warehouse. |