FireDAC Components for Snowflake

Build 21.0.7958

Connection Parameters

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 Establishing a Connection.

Authentication


PropertyDescription
AuthSchemeThe authentication scheme used. Accepted entries are Password, OKTA, PrivateKey, AzureAD, OAuth, or PingFederate.
AccountThe Account provided for authentication with Snowflake database. This is usually derived from the URL automatically.
WarehouseThe name of the Snowflake warehouse.
UserThe username provided for authentication with the Snowflake database.
PasswordThe user's password.
URLThe URL of Snowflake database.
MFAPasscodeSpecifies the passcode to use for multi-factor authentication.
RoleNameThe role of the Snowflake user: PUBLIC, SYSADMIN, or ACCOUNTADMIN.
CredentialsLocationThe location of the settings file where credentials are saved.

Connection


PropertyDescription
UseVirtualHostingIf 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


PropertyDescription
AzureTenantThe Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.

SSO


PropertyDescription
ProofKeyThe ProofKey for authentication with Snowflake database. This is usually derived from GetSSOAuthorizationURL call.
ExternalTokenThe 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.
SSOPropertiesAdditional properties required to connect to the identity provider in a semicolon-separated list.

KeyPairAuth


PropertyDescription
PrivateKeyThe private key provided for key pair authentication with Snowflake.
PrivateKeyPasswordThe password for the private key specified in the PrivateKey property, if required.
PrivateKeyTypeThe type of key store containing the private key to use with key pair authentication.

OAuth


PropertyDescription
InitiateOAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientIdThe client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessTokenThe access token for connecting using OAuth.
CallbackURLThe OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your Add-In settings.
StateAn optional value that has meaning for your OAuth App.
OAuthSettingsLocationThe 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://.
OAuthAuthenticatorThis determines the authenticator that the OAuth application requests from Snowflake.
ScopeThis determines the scopes that the OAuth application requests from Snowflake.
OAuthAuthorizationURLThe authorization URL for the OAuth service.
OAuthAccessTokenURLThe URL to retrieve the OAuth access token from.
OAuthVerifierThe verifier code returned from the OAuth authorization URL.
PKCEVerifierA random value used as input for calling GetOAuthAccessToken in the PKCE flow.
OAuthRefreshTokenThe OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresInThe lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.

SSL


PropertyDescription
SSLServerCertThe certificate to be accepted from the server when connecting using TLS/SSL.

Firewall


PropertyDescription
FirewallTypeThe protocol used by a proxy-based firewall.
FirewallServerThe name or IP address of a proxy-based firewall.
FirewallPortThe TCP port for a proxy-based firewall.
FirewallUserThe user name to use to authenticate with a proxy-based firewall.
FirewallPasswordA password used to authenticate to a proxy-based firewall.

Proxy


PropertyDescription
ProxyAutoDetectThis 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.
ProxyServerThe hostname or IP address of a proxy to route HTTP traffic through.
ProxyPortThe TCP port the ProxyServer proxy is running on.
ProxyAuthSchemeThe authentication type to use to authenticate to the ProxyServer proxy.
ProxyUserA user name to be used to authenticate to the ProxyServer proxy.
ProxyPasswordA password to be used to authenticate to the ProxyServer proxy.
ProxySSLTypeThe SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging


PropertyDescription
LogfileA filepath which designates the name and location of the log file.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
LogModulesCore modules to be included in the log file.
MaxLogFileSizeA string specifying the maximum size in bytes for a log file (for example, 10 MB).
MaxLogFileCountA string specifying the maximum file count of log files.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
DatabaseThe name of the Snowflake database.
SchemaThe schema of the Snowflake database.

Caching


PropertyDescription
AutoCacheAutomatically caches the results of SELECT queries into a cache database specified by either CacheLocation or both of CacheConnection and CacheProvider .
CacheProviderThe name of the provider to be used to cache data.
CacheConnectionThe 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.
CacheLocationSpecifies the path to the cache when caching to a file.
CacheToleranceThe tolerance for stale data in the cache specified in seconds when using AutoCache .
OfflineUse offline mode to get the data from the cache instead of the live source.
CacheMetadataThis property determines whether or not to cache the table metadata to a file store.

Miscellaneous


PropertyDescription
AllowPreparedStatementPrepare a query statement before its execution.
ApplicationNameThe application name connection string property expresses the client application's name.
AsyncQueryTimeoutThe timeout for asynchronous requests issued by the provider to download large result sets.
CustomStageThe name of a custom stage to use during bulk write operations.
EnableArrowWhether to support Apache Arrow.
ExternalStageAWSAccessKeyYour AWS account access key. Only used when defining a CustomStage for bulk write operations.
ExternalStageAWSSecretKeyYour AWS account secret key. Only used when defining a CustomStage for bulk write operations.
ExternalStageAzureAccessKeyThe storage key associated with your Azure Blob storage account. Only used when defining a CustomStage for bulk write operations.
IgnoreCaseWhether to ignore case in identifiers. Default: false.
IncludeTableTypesIf set to true, the provider will report the types of individual tables and views.
MaximumColumnSizeThe maximum column size.
MaxRowsLimits 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.
MaxThreadsSpecifies the number of concurrent requests.
MergeDeleteA 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.
MergeInsertA boolean indicating whether INSERT statements should be converted to MERGE statements automatically. Only used when the INSERT contains a table's primary key field.
MergeUpdateA 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.
OtherThese hidden properties are used only in specific use cases.
PagesizeThe maximum number of results to return per page from Snowflake.
PseudoColumnsThis property indicates whether or not to include pseudo columns as columns to the table.
QueryPassthroughThis option passes the query to the Snowflake server as is.
ReadonlyYou can use this property to enforce read-only access to Snowflake from the provider.
ReplaceInvalidUTF8CharsSpecifies whether to repalce invalid UTF8 characters with a '?'.
RetryOnS3TimeoutWhether or not to retry when network issues occur at during chunk downloading.
RTKThe runtime key used for licensing.
SessionParametersThe session parameters for Snowflake. For example: SessionParameters='QUERY_TAG=MyTag;QUOTED_IDENTIFIERS_IGNORE_CASE=True;';.
SupportEnhancedSQLThis property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseAsyncQueryThis field sets whether async query is enabled.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7958