Databricks - Run Job

In this article

Overview

You can use this Snap to automate the execution of a set of tasks or processes within a Databricks workspace. It triggers the task and periodically checks its progress. The Snap stops after the job is complete, but if you cancel the pipeline before the task finishes, the Snap requests to terminate the task.

databricks-run-job-overview.png

Example

Run Job on a Cluster

The following example pipeline demonstrates how to run a job specified in the notebook on a cluster.Snap Type

The Databricks - Run Job Snap is a Write-type Snap.

Prerequisites

  • Valid client ID.

  • A valid account with the required permissions.

Support for Ultra Pipelines

Limitations and Known Issues

None.

Snap Views

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

 

  • Min: 0

  • Max: 1

  • Mapper

  • Copy

Requires a valid task name, notebook path, and cluster-info.

Output

Document

 

  • Min: 1

  • Max: 1

  • Mapper

  • Filter

Executes the selected notebook.

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 when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:

  • Stop Pipeline Execution: Stops the current pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining 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 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 field set.

  • Remove icon ( ): Indicates that you can remove fields from the field set.

  • Upload icon ( ): Indicates that you can upload files.

Field Name

Field Type

Description

Field Name

Field Type

Description

Label*

 

Default ValueDatabricks - Run Job
ExampleRun Job

String

Specify 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.

 

Task name*

 

Default Value: N/A
Example: Test username and password

String/Expression

Specify the name of the task to perform the job.

Notebook path*

 

Default Value: N/A
Example: /Users/johndoe@snaplogic.com/notebook

String/Expression/Suggestion

Specify the path of the saved notebook that will run in this job. Notebook is a web-based interface that allows you to create, edit, and execute data science and data engineering workflows. Learn more about Databricks notebooks.

Cluster*

 

Default Value: N/A
Example: Code Ammonite - Shared Compute Cluster - V2

String/Expression/Suggest

Specify the cluster to run the job within its environment.

Parameter(s)

Use this field set to specify the parameters to run the job.

Key*

Default Value: N/A
ExampleAge

String/Expression

Specify the parameter key.

Value*

Default Value: N/A
Example35

String/Expression

Specify the parameter value.

Interval check (seconds)*

 

Default Value10
Example15

Integer/Expression

Specify the number of seconds to wait before checking the status of the task.

Snap Execution

Default ValueExecute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

  • 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.

Example

Run Job on a Cluster

The following example pipeline demonstrates how to run a job specified in the notebook on a cluster.

databricks-run-job-example-overview.png

Download this pipeline.

Step 1: Configure the Databricks - Run Job Snap with the following settings:

a. Task name: Specify the task the Databricks - Run Job Snap must perform in this field.

b. Notebook path: Specify the path to the Databricks notebook that contains the code to be executed. This path indicates the location within the Databricks environment where the notebook is stored.

c. Cluster: Specify the cluster on which the job must be executed. The cluster configuration (including computational resources) is predefined and identified by this name and ID.

d. Interval check (seconds): Specify the frequency (in seconds) at which the Snap will check the status of the running job. In this case, it will check every 10 seconds.

Databricks - Run Job Configuration

Databricks - Run Job Output

Databricks - Run Job Configuration

Databricks - Run Job Output

 

Step 2: Configure the Mapper Snap to store the result status of the Databricks - Run Job Snap. On validation, the Mapper Snap displays the job success message.

Downloads

  File Modified

File example-databricks-run-job.slp

Aug 07, 2024 by Lakshmi Manda