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.
Property | Description |
AuthScheme | The authentication scheme used. Accepted entries are PersonalAccessToken, AzureServicePrincipal. |
Server | The host name or IP address of the server hosting the Databricks database. |
ProtocolVersion | The Protocol Version used to authenticate with Databricks. |
Database | The name of the Databricks database. |
HTTPPath | The path component of the URL endpoint. |
Token | The token used to access the Databricks server. |
Property | Description |
AWSAccessKey | Your AWS account access key. This value is accessible from your AWS security credentials page. |
AWSSecretKey | Your AWS account secret key. This value is accessible from your AWS security credentials page. |
AWSRegion | The hosting region for your Amazon Web Services. |
AWSS3Bucket | The name of your AWS S3 bucket. |
Property | Description |
AzureStorageAccount | The name of your Azure storage account. |
AzureAccessKey | The storage key associated with your Databricks account. |
AzureBlobContainer | The name of your Azure Blob storage container. |
AzureServicePrincipal Authentication
Property | Description |
AzureTenantId | The Tenant id of your Microsoft Azure Active Directory. |
AzureClientId | The application(client) id of your Microsoft Azure Active Directory application. |
AzureClientSecret | The application(client) secret of your Microsoft Azure Active Directory application. |
AzureSubscriptionId | The Subscription id of your Azure Databricks Service Workspace. |
AzureResourceGroup | The Resource Group name of your Azure Databricks Service Workspace. |
AzureWorkspace | The name of your Azure Databricks Service Workspace. |
Property | Description |
SSLClientCert | The TLS/SSL client certificate store for SSL Client Authentication (2-way SSL). |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLClientCertSubject | The subject of the TLS/SSL client certificate. |
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 | 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. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
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 |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
PrimaryKeyIdentifiers | Set this property to define primary keys. |
Property | Description |
CloudStorageType | Determine which cloud storage service will be used. |
StoreTableInCloud | This option specifies whether Databricks server will create and save tables in cloud storage. |
QueryTableDetails | Specifies whether to use DESCRIBE FORMATTED ... to query detailed table information, the query will take a long time if set it to True. |
UseUploadApi | This option specifies whether the Databricks Upload API will be used when executing Bulk Insert operations. |
UseCloudFetch | This option specifies whether to use CloudWatch to improve query efficiency when the data volume of the table is large. |
UseLegacyDataModel | This option specifies whether to support Unity Catalog. |
Property | Description |
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. |
DescribeCommand | The describe command used to communicate with the Hive server. Accepted entries are DESCRIBE and DESC. |
DetectView | Specifies whether to use DESCRIBE FORMATTED ... to detect the specified table is view or not. |
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. |
Other | These hidden properties are used only in specific use cases. |
Readonly | You can use this property to enforce read-only access to Databricks from the provider. |
ServerConfigurations | A name-value list of server configuration variables to override the server defaults. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseDescTableQuery | This 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. |
UseInsertSelectSyntax | Specifies whether to use an INSERT INTO SELECT statement. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |