Databricks

Reference for the Tracecat Databricks integration: registered actions, required secrets, expected inputs, and example workflow usage.

Cancel job run

Action ID: tools.databricks.cancel_run

Cancel a job run asynchronously.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.cancel_run

Input fields

run_id · integer · required

Canonical identifier of the run to cancel.

base_url · string | null

Databricks workspace URL.

Default: null.

Cancel SQL statement

Action ID: tools.databricks.cancel_statement

Cancel execution of a SQL statement.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.cancel_execution

Input fields

statement_id · string · required

Identifier of the SQL statement to cancel.

base_url · string | null

Databricks workspace URL.

Default: null.

Execute SQL statement

Action ID: tools.databricks.execute_statement

Execute a SQL statement on a Databricks SQL warehouse.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.execute_statement

Input fields

statement · string · required

SQL statement to execute.

warehouse_id · string · required

Identifier of the SQL warehouse.

base_url · string | null

Databricks workspace URL.

Default: null.

byte_limit · integer | null

Maximum number of result bytes to return inline.

Default: null.

catalog · string | null

Default catalog for statement execution.

Default: null.

row_limit · integer | null

Maximum number of result rows to return inline.

Default: null.

schema · string | null

Default schema for statement execution.

Default: null.

wait_timeout · string | null

Time to wait for a result, from 0s through 50s.

Default: null.

Get cluster

Action ID: tools.databricks.get_cluster

Retrieve information for a cluster by identifier.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.get

Input fields

cluster_id · string · required

Cluster about which to retrieve information.

base_url · string | null

Databricks workspace URL.

Default: null.

Get job

Action ID: tools.databricks.get_job

Retrieve a single job by identifier.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.get

Input fields

job_id · integer · required

Canonical identifier of the job.

base_url · string | null

Databricks workspace URL.

Default: null.

include_trigger_state · boolean | null

Whether to include trigger state in the response.

Default: null.

page_token · string | null

Token for a subsequent page of job arrays.

Default: null.

Get job run

Action ID: tools.databricks.get_run

Retrieve metadata for a job run.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.get_run

Input fields

run_id · integer · required

Canonical identifier of the run.

base_url · string | null

Databricks workspace URL.

Default: null.

include_history · boolean | null

Whether to include the repair history in the response.

Default: null.

include_resolved_values · boolean | null

Whether to include resolved parameter values.

Default: null.

page_token · string | null

Token for a subsequent page of run arrays.

Default: null.

Get SQL statement

Action ID: tools.databricks.get_statement

Retrieve the status and result of a SQL statement.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.get_statement

Input fields

statement_id · string · required

Identifier of the SQL statement.

base_url · string | null

Databricks workspace URL.

Default: null.

Get SQL warehouse

Action ID: tools.databricks.get_warehouse

Retrieve information about a SQL warehouse.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.get

Input fields

id · string · required

Identifier of the SQL warehouse.

base_url · string | null

Databricks workspace URL.

Default: null.

List clusters

Action ID: tools.databricks.list_clusters

Return pinned and active clusters and recently terminated clusters.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.list

Input fields

base_url · string | null

Databricks workspace URL.

Default: null.

limit · integer

Maximum number of clusters to return across SDK pages.

Default: 1000.

page_size · integer | null

Maximum number of results for each server response.

Default: null.

page_token · string | null

Token from a previous response for the next or previous page.

Default: null.

List job runs

Action ID: tools.databricks.list_runs

List job runs in descending start-time order.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.list_runs

Input fields

active_only · boolean | null

Whether to include only active runs.

Default: null.

base_url · string | null

Databricks workspace URL.

Default: null.

completed_only · boolean | null

Whether to include only completed runs.

Default: null.

expand_tasks · boolean | null

Whether to include task and cluster details.

Default: null.

job_id · integer | null

Job identifier used to filter runs.

Default: null.

limit · integer | null

Number of runs returned per server page.

Default: null.

max_items · integer

Maximum number of runs to return across SDK pages.

Default: 1000.

page_token · string | null

Token for a subsequent page.

Default: null.

start_time_from · integer | null

Earliest run start time in epoch milliseconds.

Default: null.

start_time_to · integer | null

Latest run start time in epoch milliseconds.

Default: null.

List jobs

Action ID: tools.databricks.list_jobs

Retrieve jobs visible to the authenticated identity.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.list

Input fields

base_url · string | null

Databricks workspace URL.

Default: null.

expand_tasks · boolean | null

Whether to include task and cluster details in each job.

Default: null.

limit · integer | null

Number of jobs returned per server page.

Default: null.

max_items · integer

Maximum number of jobs to return across SDK pages.

Default: 1000.

name · string | null

Filter jobs by a case-insensitive name match.

Default: null.

page_token · string | null

Token for a subsequent page.

Default: null.

List SQL warehouses

Action ID: tools.databricks.list_warehouses

List SQL warehouses in the workspace.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.list

Input fields

base_url · string | null

Databricks workspace URL.

Default: null.

limit · integer

Maximum number of warehouses to return across SDK pages.

Default: 1000.

page_size · integer | null

Maximum number of warehouses returned per server page.

Default: null.

page_token · string | null

Token for a subsequent page.

Default: null.

Run job

Action ID: tools.databricks.run_job

Start a run of an existing job.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.run_now

Input fields

job_id · integer · required

Identifier of the job to run.

base_url · string | null

Databricks workspace URL.

Default: null.

idempotency_token · string | null

Token used to guarantee idempotency of the run request.

Default: null.

job_parameters · map[string, string] | null

Job-level parameter values for the run.

Default: null.

notebook_params · map[string, string] | null

Parameters to pass to notebook tasks.

Default: null.

python_named_params · map[string, string] | null

Named parameters to pass to Python wheel tasks.

Default: null.

python_params · array[string] | null

Parameters to pass to Python tasks.

Default: null.

sql_params · map[string, string] | null

Parameters to pass to SQL tasks.

Default: null.

Start cluster

Action ID: tools.databricks.start_cluster

Start a terminated all-purpose cluster.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.start

Input fields

cluster_id · string · required

Cluster to start.

base_url · string | null

Databricks workspace URL.

Default: null.

Start SQL warehouse

Action ID: tools.databricks.start_warehouse

Start a SQL warehouse.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.start

Input fields

id · string · required

Identifier of the SQL warehouse to start.

base_url · string | null

Databricks workspace URL.

Default: null.

Stop SQL warehouse

Action ID: tools.databricks.stop_warehouse

Stop a SQL warehouse.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.stop

Input fields

id · string · required

Identifier of the SQL warehouse to stop.

base_url · string | null

Databricks workspace URL.

Default: null.

Terminate cluster

Action ID: tools.databricks.terminate_cluster

Terminate a cluster asynchronously.

Reference: https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.delete

Input fields

cluster_id · string · required

Cluster to terminate.

base_url · string | null

Databricks workspace URL.

Default: null.