In this article

Overview

You can use this Snap to run one or more Databricks SQL statements on your target Databricks Lakehouse Platform (DLP) instance. You can run the following types of queries using this Snap:

Data Definition Language (DDL) queries
Data Manipulation Language (DML) queries
Data Control Language (DCL) queries

The Snap runs each statement as a single atomic unit so as to allow rolling back changes when a statement fails during its execution.

Snap Type

Databricks - Execute Snap is a write-type Snap that can read, fetch, and write data and tables into a target DLP instance.

Prerequisites

Valid access credentials to a DLP instance with adequate access permissions to perform the action in context.
Valid access to the external source data in one of the following: Azure Blob Storage, ADLS Gen2, DBFS, GCP, AWS S3, or another database (JDBC-compatible).

Support for Ultra Pipelines

Does not support Ultra Pipelines.

Limitations

This Snap does not support multi-statement transaction rollback.
Each statement is auto-committed upon successful execution. In the event of a failure, the Snap can rollback only updates corresponding to the failed statement execution. All previous statements (during that Pipeline execution runtime) that ran successfully are not rolled back.
You cannot run Data Query Language (DQL) queries using this Snap. For example, SELECT and WITH query constructs.

Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input

Document

Min: 0
Max: 1

JSON Generator
Mapper
Copy
Databricks - Select

Input document is not mandatory. The Snap can fetch and apply values for parameterized queries from an upstream Snap output.

Output

Document

Min: 0
Max: 1

Databricks - Select
Databricks - Insert

A JSON document containing each SQL statement along with its execution status (or result).

Error

Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter while running the Pipeline by choosing one of the following options from the When errors occur list under the Views tab. The available options are:

Stop Pipeline Execution: Stops the current pipeline execution when the Snap encounters an error.
Discard Error Data and Continue: Ignores the error, discards that record, and continues with the rest of the records.
Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

Learn more about Error handling in Pipelines.

Snap Settings

Asterisk ( * ): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates whether the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon ( ): Indicates that you can remove fields from the fieldset.

Field Name		Field Type	Description
Label* Default Value: Databricks - Execute Example: Db_MultiQuery		String	The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your Pipeline.
SQL Statements*	Use this fieldset to define your SQL statements, one in each row. You can add as many SQL statements as you need.
SQL Statements*	SQL statement* Default Value: None. Example: create table employee (name String, age BigInt)	String/Expression	Specify the Databricks SQL statement you want the Snap to execute. The SQL statement must follow the SQL syntax as stipulated in DLP.
Number of Retries Default value: 0 Example: 3 Minimum value: 0		Integer	Specifies the maximum number of retry attempts when the Snap fails to write.
Retry Interval (seconds) Default value: 1 Example: 3 Minimum value: 1		Integer	Specifies the minimum number of seconds the Snap must wait before each retry attempt.
Add Result Query		Checkbox	Select this checkbox to write the SQL statement execution result to the Snap's output view for each successful execution. The output of the Snap is enclosed in the key `ResultQuery,` and the value will be the actual output produced by the SQL statement. The example Pipeline below depicts the difference between the output previews when this checkbox is selected and when it is not. This option allows you to effectively track the SQL statement's execution by clearly indicating the successful execution and the number of records affected, if any, after the execution. For DDL statements Because the Databricks JDBC driver does not return a result set for Data Definition Language (DDL) statements such as DROP, CREATE, and ALTER, the Snap displays a standard message: `SQL statement executed successfully but did not produce any result set.`
Manage Queued Queries Default value: Continue to execute queued queries when pipeline is stopped or if it fails. Example: Cancel queued queries when pipeline is stopped or if it fails		Dropdown list	Select this property to determine whether the Snap should continue or cancel the execution of the queued Databricks SQL queries when you stop the Pipeline. If you select Cancel queued queries when pipeline is stopped or if it fails, then the read queries under execution are cancelled, whereas the write type of queries under execution are not cancelled. Databricks internally determines which queries are safe to be cancelled and cancels those queries. Due to an issue with DLP, aborting an ELT Pipeline validation (with preview data enabled) causes only those SQL statements that retrieve data using bind parameters to get aborted while all other static statements (that use values instead of bind parameters) persist. For example, `select * from a_table where id = 10` will not be aborted while `select * from test where id = ?` gets aborted. To avoid this issue, ensure that you always configure your Snap settings to use bind parameters inside its SQL queries.
Snap Execution Default Value: Execute only Example: Validate & Execute		Dropdown list	Select one of the three modes in which the Snap executes. Available options are: Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime. Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data. Disabled: Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error	Reason	Resolution
Missing property value	You have not specified a value for the required field where this message appears.	Ensure that you specify valid values for all required fields.

Examples

Replacing old data in a DLP table with the latest data

Consider the scenario where the data in a DLP table becomes obsolete every few hours. We need to refresh the data in the table on a frequent basis. To do so, we can create the following Pipeline with only Databricks - Execute Snap.

Configure the Snap (Pipeline) to run two Databricks SQL statements in a specific order - Delete the existing table and create a new table with the same schema as the source file and populate the latest values into this new table. Ensure that the DLP account used with the Snap has the required permissions to perform operations you specify in your SQL statements.

The Snap upon successful validation displays the output in the preview pane as follows. This output contains the SQL statement we passed and the respective result of execution.

Download this Pipeline.

Downloads

Download and import the Pipeline into SnapLogic.
Configure Snap accounts as applicable.
Provide Pipeline parameters as applicable.

	File	Modified

No files shared here yet.

Snap Pack History

Release	Snap Pack Version	Date	Type	Updates
August 2024	main27765	21 Aug 2024	Stable	Upgraded the `org.json.json` library from v20090211 to v20240303, which is fully backward compatible.
May 2024	437patches27246	08 Aug 2024	Latest	Added Databricks - Run Job. This Snap executes a job, checks its status in Databricks, and, based on the job's status, completes or fails the pipeline.
May 2024	437patches26400	15 May 2024	Latest	Fixed an invalid session handle issue with the Databricks Snap Pack that intermittently triggered an error message when the Snaps failed to connect with Databricks to execute the SQL statement.
May 2024	main26341	08 May 2024	Stable	Updated the Delete Condition (Truncates a Table if empty) field in the Databricks - Delete Snap to Delete condition (deletes all records from a table if left blank) to indicate that all entries will be deleted from the table when this field is blank, but no truncate operation is performed.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	433patches21630	28 Jun 2023	Latest	Enhanced the performance of the Databricks - Insert Snap to improve the amount of time it takes for validation.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	The Databricks - Insert Snap now creates the target table only from the table metadata of the second input view when the following conditions are met: The Create table if not present checkbox is selected. The target table does not exist. The table metadata is provided in the second input view.
September 2022	430patches18305	29 Sep 2022	Latest	The name of the Databricks - Multi Execute Snap is simplified to Databricks - Execute Snap. The Use Result Query checkbox in the Databricks - Execute Snap enables you to include in the Snap's output the result of running (during validation) each SQL statement specified in the Snap. The Retry mechanism for the Databricks Snap Pack enables the following Databricks Snaps to repeatedly perform the selected operations for the specified number of times when the Snap account connection fails or times out. Databricks - Delete Databricks - Insert Databricks - Select Databricks - Execute Databricks - Bulk Load (when the Source Type is Input View) Databricks - Merge Into (when the Source Type is Input View) The following fields are added to each Databricks Snap as part of this enhancement: Number of Retries: The number of attempts the Snap should make to perform the selected operation when the Snap account connection fails or times out. Retry Interval (seconds): The time interval in seconds between two consecutive retry attempts.
September 2022	430patches17796	28 Sep 2022	Latest	The Manage Queued Queries property in the Databricks Snap Pack enables you to decide whether a given Snap should continue or cancel executing the queued Databricks SQL queries.
August 2022	main17386	11 Aug 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.29.2.0	42920rc17045	15 Jul 2022	Latest	A new Snap Pack for Databricks Lakehouse Platform (Databricks or DLP) introduces the following Snaps: Databricks - Select: Retrieves information from the target Databricks table. Databricks - Insert: Inserts new rows of data in the target Databricks table. Databricks - Delete: Deletes data from a target Databricks table. Databricks - Bulk Load: Loads millions of rows of data in the target table through a single load operation. Databricks - Unload: Unloads data from a target Databricks table through a single unload operation. Databricks - Merge Into: Updates millions of existing rows and inserts new rows in a target Databricks table through a single operation. Databricks - Multi Execute: Runs multiple SQL statements on the target Databricks instance.

Databricks - Execute