Parameters (Connect-Snowflake Cmdlet)
The following is the full list of the parameters of the cmdlet with short descriptions. Click the links for further details.
| Property | Description |
| AuthScheme | The authentication scheme used. Accepted entries are Password, OKTA, PrivateKey, AzureAD, AzureMSI, OAuth, PingFederate, or ExternalBrowser. |
| 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. |
| MFAPasscode | Specifies the passcode to use for multi-factor authentication. |
| RoleName | The role of the Snowflake user: PUBLIC, SYSADMIN, or ACCOUNTADMIN. |
| CredentialsLocation | The location of the settings file where credentials are saved. |
| AzureResource | The Azure Active resource to authenticate to (used during Azure Managed Service Identity exchange).It should be set to the App Id URI. |
| 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. |
| Property | Description |
| AzureTenant | The Microsoft Online tenant being used to access data. If not specified, your default tenant is used. |
| 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. |
| 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. |
| PrivateKeySubject | The subject of the certificate containing the private key to use with key pair authentication. |
| 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, you can hold this location 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. |
| Property | Description |
| SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
| 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. |
| Property | Description |
| ProxyAutoDetect | When this connection property is set to True, the provider checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details). Set to False if you want to manually configure the provider to connect to a specific proxy server. |
| ProxyServer | The hostname or IP address of the proxy server that you want to route HTTP traffic through. |
| ProxyPort | The TCP port that the proxy server (specified in the ProxyServer connection property) is running on. |
| ProxyAuthScheme | The authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property. |
| ProxyUser | The username of a user account registered with the proxy server specified in the ProxyServer connnection property. |
| ProxyPassword | The password associated with the user specified in the ProxyUser connection property. |
| 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 . |
| Property | Description |
| Logfile | A filepath which designates the name and location of the log file. |
| Verbosity | The verbosity level that determines the amount of detail included in the log file. |
| LogModules | Core modules to be included in the log file. |
| MaxLogFileSize | A string specifying the maximum size in bytes for a log file (for example, 10 MB). |
| MaxLogFileCount | A string specifying the maximum file count of log files. |
| Property | Description |
| Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
| BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
| Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
| Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
| Database | The name of the Snowflake database. |
| Schema | The schema of the Snowflake database. |
| Property | Description |
| AutoCache | Automatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider . |
| CacheLocation | Specifies the path to the cache when caching to a file. |
| CacheTolerance | The tolerance for stale data in the cache specified in seconds when using AutoCache . |
| Offline | Use offline mode to get the data from the cache instead of the live source. |
| CacheMetadata | This property determines whether or not to cache the table metadata to a file store. |
| Property | Description |
| AllowPreparedStatement | Prepare a query statement before its execution. |
| AllowUserVariables | When set to True, user variables (prefixed by an $) can be used in SQL queries. |
| ApplicationName | The application name connection string property expresses the HTTP User-Agent. |
| AsyncQueryTimeout | The timeout for asynchronous requests issued by the provider to download large result sets. |
| BatchMode | Allow specifying the batch mode. Default: Auto. |
| BindingType | Allow specifying the binding type for the Date, Time and Timestamp_* type. |
| CustomStage | The name of a custom stage to use during bulk write operations. |
| 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 when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
| 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. |
| 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. |
| ReplaceInvalidUTF8Chars | Specifies whether to repalce invalid UTF8 characters with a '?'. |
| RetryOnS3Timeout | Whether or not to retry when network issues occur at during chunk downloading. |
| RTK | The runtime key used for licensing. |
| S3Domain | The URI of the S3 bucket you are using as your Snowflake S3 stage. |
| SessionIdleTimeout | The timeout minutes for Session, the values comes from Snowflake's session policy, which indicate the session policy parameter SESSION_IDLE_TIMEOUT_MINS. The default value is 240 minutes. |
| 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. |