InTouch Hub · Blue Isle Software

Databricks

Execute SQL statements on a Databricks SQL warehouse and list clusters, jobs, warehouses and Unity Catalog catalogs through the Databricks REST API.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

bibusinessbusiness-intelligencedatabricksintelligencestatus

Databricks Tool

List clusters, jobs, SQL warehouses and Unity Catalog catalogs, and run SQL, on a Databricks workspace via the Databricks REST API.

Tool ID

databricks-sql

Credential Required

Yes — an API-key credential (auth mode: bearer). The credential's secret is a Databricks personal access token (PAT), generated in the workspace under Settings → Developer → Access tokens. It is sent on every request as Authorization: Bearer <token>. All requests go to https://<host>/api — the workspace host comes from the task's host input, not the credential.

Credential Properties

Property Type Default Description
apiKey string — Required. API key / token used to authenticate — the Databricks personal access token (the credential's secret/password field is also honoured)

A task-input apiKey is honoured as a fallback for older tasks, but the token should live in the credential vault.

Operations

1. list_clusters — List clusters

Lists the workspace's compute clusters. Calls GET /2.0/clusters/list.

Properties:

Property Type Default Description
operation string (enum) — Required. One of: list_clusters, list_jobs, list_warehouses, execute_statement, list_catalogs
host string — Required. Databricks workspace host, e.g. dbc-xxxxxxxx.cloud.databricks.com (no scheme)
query string — Optional query params as a JSON object string, e.g. {"page_size": 20}

Published Outputs: - result — the JSON response body - status — HTTP status code

2. list_jobs — List jobs

Lists the workspace's jobs. Calls GET /2.1/jobs/list.

Properties:

Property Type Default Description
operation string (enum) — Required.
host string — Required. Databricks workspace host (no scheme)
query string — Optional query params as a JSON object string, e.g. {"page_size": 20}

Published Outputs: - result — the JSON response body - status — HTTP status code

3. list_warehouses — List SQL warehouses

Lists the workspace's SQL warehouses. Calls GET /2.0/sql/warehouses.

Properties:

Property Type Default Description
operation string (enum) — Required.
host string — Required. Databricks workspace host (no scheme)
query string — Optional query params as a JSON object string

Published Outputs: - result — the JSON response body - status — HTTP status code

4. execute_statement — Run a SQL statement

Executes a SQL statement on a SQL warehouse. Calls POST /2.0/sql/statements with a JSON body.

Properties:

Property Type Default Description
operation string (enum) — Required.
host string — Required. Databricks workspace host (no scheme)
body string — Request body as a JSON object string, e.g. {"statement": "select 1", "warehouse_id": "abc123"}
query string — Optional query params as a JSON object string

Published Outputs: - result — the JSON response body - status — HTTP status code

5. list_catalogs — List Unity Catalog catalogs

Lists Unity Catalog catalogs. Calls GET /2.1/unity-catalog/catalogs.

Properties:

Property Type Default Description
operation string (enum) — Required.
host string — Required. Databricks workspace host (no scheme)
query string — Optional query params as a JSON object string

Published Outputs: - result — the JSON response body - status — HTTP status code

Self-Contained JAR

The jar bundles all runtime dependencies; only intouch-tool-api is provided by the server.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.