> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tracecat.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.cancel_run)

### Input fields

<ParamField path="run_id" type="integer" required>
  Canonical identifier of the run to cancel.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.cancel_execution)

### Input fields

<ParamField path="statement_id" type="string" required>
  Identifier of the SQL statement to cancel.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.execute_statement)

### Input fields

<ParamField path="statement" type="string" required>
  SQL statement to execute.
</ParamField>

<ParamField path="warehouse_id" type="string" required>
  Identifier of the SQL warehouse.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="byte_limit" type="integer | null">
  Maximum number of result bytes to return inline.

  Default: `null`.
</ParamField>

<ParamField path="catalog" type="string | null">
  Default catalog for statement execution.

  Default: `null`.
</ParamField>

<ParamField path="row_limit" type="integer | null">
  Maximum number of result rows to return inline.

  Default: `null`.
</ParamField>

<ParamField path="schema" type="string | null">
  Default schema for statement execution.

  Default: `null`.
</ParamField>

<ParamField path="wait_timeout" type="string | null">
  Time to wait for a result, from 0s through 50s.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.get)

### Input fields

<ParamField path="cluster_id" type="string" required>
  Cluster about which to retrieve information.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.get)

### Input fields

<ParamField path="job_id" type="integer" required>
  Canonical identifier of the job.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="include_trigger_state" type="boolean | null">
  Whether to include trigger state in the response.

  Default: `null`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token for a subsequent page of job arrays.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.get_run)

### Input fields

<ParamField path="run_id" type="integer" required>
  Canonical identifier of the run.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="include_history" type="boolean | null">
  Whether to include the repair history in the response.

  Default: `null`.
</ParamField>

<ParamField path="include_resolved_values" type="boolean | null">
  Whether to include resolved parameter values.

  Default: `null`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token for a subsequent page of run arrays.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/statement_execution.html#databricks.sdk.service.sql.StatementExecutionAPI.get_statement)

### Input fields

<ParamField path="statement_id" type="string" required>
  Identifier of the SQL statement.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.get)

### Input fields

<ParamField path="id" type="string" required>
  Identifier of the SQL warehouse.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.list)

### Input fields

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="limit" type="integer">
  Maximum number of clusters to return across SDK pages.

  Default: `1000`.
</ParamField>

<ParamField path="page_size" type="integer | null">
  Maximum number of results for each server response.

  Default: `null`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token from a previous response for the next or previous page.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.list_runs)

### Input fields

<ParamField path="active_only" type="boolean | null">
  Whether to include only active runs.

  Default: `null`.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="completed_only" type="boolean | null">
  Whether to include only completed runs.

  Default: `null`.
</ParamField>

<ParamField path="expand_tasks" type="boolean | null">
  Whether to include task and cluster details.

  Default: `null`.
</ParamField>

<ParamField path="job_id" type="integer | null">
  Job identifier used to filter runs.

  Default: `null`.
</ParamField>

<ParamField path="limit" type="integer | null">
  Number of runs returned per server page.

  Default: `null`.
</ParamField>

<ParamField path="max_items" type="integer">
  Maximum number of runs to return across SDK pages.

  Default: `1000`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token for a subsequent page.

  Default: `null`.
</ParamField>

<ParamField path="start_time_from" type="integer | null">
  Earliest run start time in epoch milliseconds.

  Default: `null`.
</ParamField>

<ParamField path="start_time_to" type="integer | null">
  Latest run start time in epoch milliseconds.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.list)

### Input fields

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="expand_tasks" type="boolean | null">
  Whether to include task and cluster details in each job.

  Default: `null`.
</ParamField>

<ParamField path="limit" type="integer | null">
  Number of jobs returned per server page.

  Default: `null`.
</ParamField>

<ParamField path="max_items" type="integer">
  Maximum number of jobs to return across SDK pages.

  Default: `1000`.
</ParamField>

<ParamField path="name" type="string | null">
  Filter jobs by a case-insensitive name match.

  Default: `null`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token for a subsequent page.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.list)

### Input fields

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="limit" type="integer">
  Maximum number of warehouses to return across SDK pages.

  Default: `1000`.
</ParamField>

<ParamField path="page_size" type="integer | null">
  Maximum number of warehouses returned per server page.

  Default: `null`.
</ParamField>

<ParamField path="page_token" type="string | null">
  Token for a subsequent page.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/jobs/jobs.html#databricks.sdk.service.jobs.JobsExt.run_now)

### Input fields

<ParamField path="job_id" type="integer" required>
  Identifier of the job to run.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

<ParamField path="idempotency_token" type="string | null">
  Token used to guarantee idempotency of the run request.

  Default: `null`.
</ParamField>

<ParamField path="job_parameters" type="map[string, string] | null">
  Job-level parameter values for the run.

  Default: `null`.
</ParamField>

<ParamField path="notebook_params" type="map[string, string] | null">
  Parameters to pass to notebook tasks.

  Default: `null`.
</ParamField>

<ParamField path="python_named_params" type="map[string, string] | null">
  Named parameters to pass to Python wheel tasks.

  Default: `null`.
</ParamField>

<ParamField path="python_params" type="array[string] | null">
  Parameters to pass to Python tasks.

  Default: `null`.
</ParamField>

<ParamField path="sql_params" type="map[string, string] | null">
  Parameters to pass to SQL tasks.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.start)

### Input fields

<ParamField path="cluster_id" type="string" required>
  Cluster to start.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.start)

### Input fields

<ParamField path="id" type="string" required>
  Identifier of the SQL warehouse to start.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/sql/warehouses.html#databricks.sdk.service.sql.WarehousesAPI.stop)

### Input fields

<ParamField path="id" type="string" required>
  Identifier of the SQL warehouse to stop.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>

## 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](https://databricks-sdk-py.readthedocs.io/en/latest/workspace/compute/clusters.html#databricks.sdk.service.compute.ClustersExt.delete)

### Input fields

<ParamField path="cluster_id" type="string" required>
  Cluster to terminate.
</ParamField>

<ParamField path="base_url" type="string | null">
  Databricks workspace URL.

  Default: `null`.
</ParamField>