...
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default Value: [None] | String | A unique name for your account instance. | |
Client ID* Default Value: N/A | String | The OAuth Client ID (to be used for token request) that you obtain from the Snowflake Console when the client is registered. Learn more about How to generate OAuth Client ID and Client secret. | |
Client secret Default Value: N/A | String | The OAuth Client secret that you obtain from the Snowflake Console. | |
Access token* Default Value: N/A | String | Auto-generated upon account authorization. The access token is used to make API requests on behalf of the user associated with the client ID. | |
Refresh token Default Value: N/A | String | Auto-generated upon account authorization. The token used to refresh the access token. To access the API beyond the lifetime of a single access token, your application can obtain a refresh token. The application stores the refresh token for future use and automatically refreshes the access token before it expires. | |
Access token expiration Default Value: N/A | Integer | Auto-generated upon account authorization. The number of seconds after which the access token expires. We recommend that you set the | |
Header authenticated Default Value: Deselected | Checkbox | Select this checkbox to enable the endpoint's bearer header authentication. | |
OAuth2 Endpoint* Default Value: N/A | String | Specify the endpoint in this format | |
OAuth2 Token* Default Value: N/A | String | Specify the OAuth2 token in this format | |
Token endpoint config | Use this field set to define custom properties for the OAuth2 token endpoint. This endpoint returns access tokens or refresh tokens depending on the request parameters. | ||
Token endpoint parameter Default Value: N/A | String | Specify the parameter for the token endpoint. | |
Token endpoint parameter value Default Value: N/A | String | Specify the value for the token endpoint parameter. | |
Auth endpoint config | Use this field set to define custom properties for the OAuth2 authentication endpoint. You can define scopes in this field set and limit the authorization to a custom role. For example, scope=session:role:R1 Learn more about Scopes. | ||
Authentication parameter Default Value: N/A | String | Specify the parameter for OAuth2 authentication. | |
Authentication parameter value Default Value: N/A | String | Specify the value for the OAuth2 authentication parameter. | |
Auto-refresh token Default Value: Deselected | Checkbox | Select this checkbox to enable auto-refresh of the access token before it expires. | |
Account properties | |||
JDBC JARs* | Use this field set to add a list of JDBC JAR files to be loaded (Snowflake JDBC JAR 3.1.0 or higher). The Snowflake account has been tested with the JDBC driver version 3.14.0. Click + to add a new row for each JDBC JAR file. Add each JAR file in a separate row. See Downloading the JDBC Driver for more information about JDBC drivers and downloading the appropriate driver for your account. | ||
JDBC Driver Default Value: N/A | String | Specify the fully-qualified name of the JDBC driver to be used for connecting to the server. The Snowflake Snap Pack is bundled with the default Snowflake JDBC JAR v3.14 file. Therefore, even if you do not provide a JDBC Driver, the account does not fail. | |
Hostname* Default value: None | String | Specify the hostname of the Snowflake server to which you want to connect the new account. | |
Port Number* Default value: 443 | Integer | Specify the port number associated with the Snowflake database server that you must use for this account. | |
Database name* Default value: None | String | Specify the name of the database to which you want to connect. | |
Warehouse name* Default value: None | String | Specify the name of the warehouse to which you want to connect. | |
JDBC Driver Class Default Value: net.snowflake.client.jdbc.SnowflakeDriver | String | Specify the JDBC driver class to use. | |
S3 Bucket Default Value: N/A | String | Specify the name of the S3 bucket that you want to use for staging data to Snowflake.
| |
S3 Folder Default Value: N/A | String/Expression | Specify the relative path to a folder in the S3 bucket listed in the S3 Bucket field. This is used as a root folder for staging data to Snowflake. | |
S3 Access-key ID Default Value: N/A | String/Expression | Specify the S3 access key ID that you want to use for AWS authentication. | |
S3 Secret key Default Value: N/A | String/Expression | Specify the S3 secret key associated with the S3 Access-ID key listed in the S3 Access-key ID field. | |
S3 AWS Token Default Value: None | String/Expression | Specify the S3 AWS Token to connect to private and protected Amazon S3 buckets. Note that only global Security Token Service (STS) regions are supported. The temporary AWS Token is used when:
| |
S3 Storage Integration Default Value: N/A | String/Expression | Specify the predefined storage integration that is used to authenticate the Amazon S3 bucket hosting as an external stage.
For more information about creating Storage Integration, see Configuring a Snowflake Storage Integration to Access Amazon S3. | |
Advanced properties | |||
URL properties | Use this field set to define the account parameter's name and its corresponding value. Click to add the parameters and the corresponding values. | ||
URL property name Default Value: N/A | String | Specify the name of the parameter for the URL property. | |
URL property value Default Value: N/A | String | Specify the value for the URL property parameter. | |
Batch size* Default Value: N/A | Integer | Specify the number of Snowflake queries that you want to execute in a batch.
| |
Fetch size* Default Value: 100 | Integer | Specify the number of rows a query must fetch for each execution. Large values may cause the server to run out of memory. | |
Min pool size* Default Value: 3 | Integer | Specify the minimum number of idle connections that you want the pool to maintain at a time. | |
Max pool size* Default Value: 15 | Integer | Specify the maximum number of connections that you want the pool to maintain at a time. | |
Max life time* Default Value: 60 | Integer | Specify the maximum lifetime of a connection in the pool, in seconds.
Minimum value: 0 | |
Idle Timeout* Default Value: 5 | Integer | Specify the maximum amount of time in seconds that a connection is allowed to sit idle in the pool. 0 indicates that idle connections are never removed from the pool. Minimum value: 0 | |
Checkout timeout* Default Value: 10000 | Integer | Specify the maximum time in milliseconds you want the system to wait for a connection to become available when the pool is exhausted. If you provide 0, the Snap waits infinitely until the connection is available. Therefore, we recommend you not to specify 0 for Checkout Timeout. For any other value other than 0, the Snap displays an exception after the wait time has expired. Minimum value: 0 |
...