Label*

Default Value: N/A
Example: STD DB Acc DeltaLake AWS ALD

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 state: Deselected

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:

• JDBC JAR(s) and/or ZIP(s) : JDBC Driver

• JDBC driver class

We recommend that you use the bundled JAR file version (databricks-jdbc-2.6.40) in your pipelines. However, you may choose to use a custom JAR file version. To use a custom JDBC Driver:

1. Deselect the Download JDBC Driver Automatically checkbox.

2. In the JDBC Driver field, click the Upload icon. 

3. Select the desired JAR file, and click Upload File.

JDBC URL*

Default Value: N/A

Example: jdbc:spark://adb-2409532680880038.18.azuredatabricks.net:443/default;transportMode=http;ssl=1;httpPath=sql/protocolv1/o/2409532680880038/0326-212833-drier754;AuthMech=3;

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=
sql/protocolv1/o/6968995337014351/0521-394181-guess934;AuthMech=3;UID=token;PWD=<personal-access-token> 

Authentication type

Default value: Token authentication
Example: M2M authentication

Dropdown list

None.

Choose the authentication type to use. Available options are:

• Token-based

• Password (Deprecated): The basic authentication for Databricks using a username and password is no longer supported since July 10, 2024.

• M2M

Token

Default value: N/A
Example: dapi1234567890abcdef1234567890abcdef

String/Expression

Appears when you select Token-based as the Authentication type.

Specify the token for Databricks Lakehouse Platform authentication.

Username

Default value: N/A
Example: snapuser

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
Example: <Encrypted>

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
Example: 12345678-abcd-1234-efgh-56789abcdef0

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
Example: ABCD1234abcd5678EFGHijkl9012MNOP

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
Example: Default

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
Example: JDBC

Dropdown list

None.

Select the source or target data warehouse into which the queries must be loaded. The available options are:

• None: Select None when using Read Snaps, and if you do not want to write anything to the target data warehouse.

• Amazon S3

• Azure Blob Storage

• Azure Data Lake Storage Gen2

• DBFS

• Google Cloud Storage

• JDBC

Learn more about settings specific to each data warehouse: Source/Target location

Advanced Properties

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
Example: queryTimeout

String

None

Specify the name of the parameter for the URL property.

URL property value

Default Value: N/A
Example: 0

String

None

Specify the value for the URL property parameter.

Batch size*

Default Value: N/A
Example: 3

Integer

None

Specify the number of queries that you want to execute at a time.

• If the Batch size is one, the query is executed as-is, that is the Snap skips the batch (nonbatch execution).

• If the Batch size is greater than one, the Snap performs the regular batch execution.

Fetch size*

Default Value: 100
Example: 12

Integer

None

Specify the number of rows a query must fetch for each execution.

Larger values could cause the server to run out of memory.

Min pool size*

Default Value: 3
Example: 0

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
Example: 0

Integer

None

Specify the maximum number of connections that you want the pool to maintain at a time.

Max life time*

Default Value: 60
Example: 50

Integer

None

Specify the maximum lifetime of a connection in the pool, in seconds:

• Ensure that the value you enter is a few seconds shorter than any database or infrastructure-imposed connection time limit.

• 0 (zero) indicates an infinite lifetime, subject to the Idle Timeout value.

• An in-use connection is never retired. Connections are removed only after they are closed.

Minimum value: 0
Maximum value: No limit

Idle Timeout*

Default Value: 5
Example: 4

Integer

None

Specify the maximum amount of time in seconds that a connection is allowed to sit idle in the pool. 

0 (zero) indicates that idle connections are never removed from the pool.

Minimum value: 0
Maximum value: No limit