Databricks Account using JDBC (Source: Any SQL Database)
In this article
Overview
You can use this account type to connect Databricks Snaps with data sources that use the Databricks account with JDBC as the source.
Prerequisites
A valid Databricks account.
Certified JDBC JAR File: databricks-jdbc-2.6.25-1.jar
Limitation
With the basic authentication type for Databricks Lakehouse Platform (DLP) reaching its end of life on July 10, 2024, SnapLogic Databricks pipelines designed to use this authentication type to connect to DLP instances would cease to succeed. We recommend that you reconfigure the corresponding Snap accounts to use the Personal access tokens (PAT) authentication type.
Account Settings
Expression : JavaScript syntax to access SnapLogic Expressions to set field values dynamically (if enabled). If disabled, you can provide a static value. Learn more.
SnapGPT : Generates SnapLogic Expressions based on natural language using SnapGPT. Learn more.
Suggestion : Populates a list of values dynamically based on your Account configuration.
Upload : Uploads files. Learn more.
Learn more about the icons in the Snap Settings dialog.
Field Name | Field Type | Field Dependency | Description | |
---|---|---|---|---|
Label*
Default Value: N/A | String | None. | Specify a unique label for the account.
| |
Account Properties* | Use this fieldset to configure the information required to establish a JDBC connection with the account. | |||
Download JDBC Driver Automatically
Default Value: Not Selected | Checkbox | None. | Select this checkbox to allow the Snap account to download the certified JDBC Driver for DLP. The following fields are disabled when this checkbox is selected:
To use a JDBC Driver that you choose, clear this checkbox, upload (to SLDB), and choose the required JAR files in the JDBC JAR(s) and/or ZIP(s): JDBC Driver field. Use of Custom JDBC JAR version You can use a different JAR file version other than the recommended listed JAR file versions. Spark JDBC and Databricks JDBC If you do not select this checkbox and use an older JDBC JAR file (older than version 2.6.25), ensure that you use:
| |
JDBC Driver Class
Default Value: com.databricks.client.jdbc.Driver | String | None. | Specify the JDBC driver class to use. | |
JDBC JARs | Use this fieldset to define list of JDBC JAR files to be loaded. | |||
JDBC Driver | String | None. | Specify or upload the JDBC driver to use. The driver name must be unique. If you leave this field blank, the default JDBC driver is loaded. | |
JDBC URL* Default Value: N/A | String | None. | Enter the JDBC driver connection string that you want to use in the syntax provided below, for connecting to your DLP instance. Learn more in Microsoft's JDBC and ODBC drivers and configuration parameters. jdbc:spark://dbc-ede87531-a2ce.cloud.databricks.com:443/default;transportMode=http;ssl=1;httpPath= Avoid using the password inside the JDBC URL. If you specify the password inside the JDBC URL, it is saved as it is and is not encrypted. Instead, we recommend using the provided Password field, to ensure that your password is encrypted. | |
Authentication type
Default value: Token authentication | Dropdown list | None. | Choose the authentication type to use. Available options are:
| |
Token
Default value: N/A | String/Expression | Appears when you select Token-based as the Authentication type. | Specify the token for Databricks Lakehous Platform authentication. | |
Username
Default value: N/A | String | Appears when you select Password as the Authentication type. | Specify the username that is allowed to connect to the database. The username will be used as the default username when retrieving connections. The username must be valid to set up the data source. | |
Password
Default value: N/A | String | Appears when you select Password as the authentication type. | Specify the password used to connect to the data source. The password will be used as the default password when retrieving connections. The password must be valid to set up the data source. | |
Client ID
Default value: N/A | String | Appears when you select M2M as the Authentication type. | Specify the unique identifier that is assigned to the application when it is registered with the OAuth2 provider. | |
Client secret
Default value: N/A | String | Appears when you select M2M as the Authentication type. | Specify the confidential key assigned to the application with the Client ID. | |
Database name*
Default Value: N/A | String | None. | Enter the name of the database to use by default. This database is used if you do not specify one in the Databricks Select or Databricks Insert Snaps.
| |
Source/Target Location*
Default Value: None | Dropdown | None. | Select the target data warehouse. If you want to load the queries from ADLS Gen2 as source, then the selected data warehouse would serve as a target and vice versa. Following are the available options:
This activates the following fields:
| |
Source JDBC URL*
Default Value: N/A | String | None. | Specify the JDBC URL of the source table. | |
Source username
Default Value: N/A | String | None. | Specify the username of the external source database. | |
Source password
Default Value: N/A | String | None. | Specify the password for the external source database. | |
Advanced Properties | Other parameters that you want to specify to configure the account. | |||
URL properties | Use this fieldset to define the account parameter's name and its corresponding value. Click + to add the parameters and the corresponding values. Add each URL property-value pair in a separate row. | |||
URL property name
Default Value: N/A | N/A | None. | Specify the name of the parameter for the URL property.
| |
URL property value
Default Value: N/A | N/A | None. | Specify the value for the URL property parameter.
| |
Batch size*
Default Value: N/A | Integer | None. | Specify the number of Databricks queries that you want to execute at a time.
| |
Fetch size*
Default Value: 100 | Integer | None. | Specify the number of rows a query must fetch for each execution. Large values could cause the server to run out of memory. | |
Min pool size*
Default Value: 3 | Integer | None. | Specify the minimum number of idle connections that you want the pool to maintain at a time.
| |
Max pool size*
Default Value: 15 | Integer | None. | Specify the maximum number of connections that you want the pool to maintain at a time.
| |
Max life time*
Default Value: 60 | Integer | None. | Specify the maximum lifetime of a connection in the pool, in seconds:
Minimum value: 0 | |
Idle Timeout*
Default Value: 5 | Integer | None. | 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 | None. | 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. Minimum value: 0 |
Snap Pack History
Related Links
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2025 SnapLogic, Inc.