TDV Adapter for Databricks

Build 21.0.8137

Connection String Options

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


PropertyDescription
AuthSchemeThe authentication scheme used. Accepted entries are PersonalAccessToken, AzureServicePrincipal.
ServerThe host name or IP address of the server hosting the Databricks database.
ProtocolVersionThe Protocol Version used to authenticate with Databricks.
DatabaseThe name of the Databricks database.
HTTPPathThe path component of the URL endpoint.
TokenThe token used to access the Databricks server.

AWS Authentication


PropertyDescription
AWSAccessKeyYour AWS account access key. This value is accessible from your AWS security credentials page.
AWSSecretKeyYour AWS account secret key. This value is accessible from your AWS security credentials page.
AWSRegionThe hosting region for your Amazon Web Services.
AWSS3BucketThe name of your AWS S3 bucket.

Azure Authentication


PropertyDescription
AzureStorageAccountThe name of your Azure storage account.
AzureAccessKeyThe storage key associated with your Databricks account.
AzureBlobContainerThe name of your Azure Blob storage container.

AzureServicePrincipal Authentication


PropertyDescription
AzureTenantIdThe Tenant id of your Microsoft Azure Active Directory.
AzureClientIdThe application(client) id of your Microsoft Azure Active Directory application.
AzureClientSecretThe application(client) secret of your Microsoft Azure Active Directory application.
AzureSubscriptionIdThe Subscription id of your Azure Databricks Service Workspace.
AzureResourceGroupThe Resource Group name of your Azure Databricks Service Workspace.
AzureWorkspaceThe name of your Azure Databricks Service Workspace.

SSL


PropertyDescription
SSLClientCertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSLClientCertTypeThe type of key store containing the TLS/SSL client certificate.
SSLClientCertPasswordThe password for the TLS/SSL client certificate.
SSLClientCertSubjectThe subject of the TLS/SSL client certificate.
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
LogModulesCore modules to be included in the log file.

Schema


PropertyDescription
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
PrimaryKeyIdentifiersSet this property to define primary keys.

Databricks


PropertyDescription
CloudStorageTypeDetermine which cloud storage service will be used.
StoreTableInCloudThis option specifies whether Databricks server will create and save tables in cloud storage.

Miscellaneous


PropertyDescription
ApplicationNameThe application name connection string property expresses the HTTP User-Agent.
AsyncQueryTimeoutThe timeout for asynchronous requests issued by the provider to download large result sets.
DescribeCommandThe describe command used to communicate with the Hive server. Accepted entries are DESCRIBE and DESC.
DetectViewSpecifies whether to use DESCRIBE FORMATTED ... to detect the specified table is view or not.
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.
OtherThese hidden properties are used only in specific use cases.
ReadonlyYou can use this property to enforce read-only access to Databricks from the provider.
ServerConfigurationsA name-value list of server configuration variables to override the server defaults.
TimeoutThe value in seconds until the timeout error is thrown, canceling the operation.
UseDescTableQueryThis option specifies whether the columns will be retrieved using a DESC TABLE query or the GetColumns Thrift API.The GetColumns Thrift API works for the Apache Spark 3.0.0 or later.
UseInsertSelectSyntaxSpecifies whether to use an INSERT INTO SELECT statement.

Copyright (c) 2022 CData Software, Inc. - All rights reserved.
Build 21.0.8137