StyloDocs
Workflow blocks

Databricks

Run SQL statements and manage Databricks SQL warehouses

View as Markdown

databricks — Run SQL statements and manage Databricks SQL warehouses.

Where it appears

The Databricks block lives in the Integrations group of the Workflow Builder. Connect the Databricks integration before adding it.

Fields

FieldTypeRequiredDefaultDescription
resourceselectYessqlWhich Databricks resource to work with. Options: sql.
operationselectYesWhich action to perform on the selected resource.
statementcodeYesRead-only SQL only. SELECT, WITH, SHOW, DESCRIBE, DESC, and EXPLAIN are allowed; write operations are blocked.
warehouseIdtext (supports references)NoOverride the warehouse configured in the integration credentials.
catalogtext (supports references)NoOptional Databricks catalog for statement execution.
schematext (supports references)NoOptional Databricks schema for statement execution.
parameterscodeNoOptional statement parameters as an array of {name, value, type}.
rowLimittext (supports references)NoOptional maximum number of rows returned.
byteLimittext (supports references)NoOptional maximum result size in bytes.
waitTimeoutSecondstext (supports references)NoOptional server-side wait timeout before the client begins polling.

Inputs and outputs

Inputs are the configurable fields above. The block produces these outputs:

Outputs

Reference an output downstream with <Databricks.field>.

NameTypeDescription
successbooleanWhether the request succeeded
warehousesarrayAvailable Databricks SQL warehouses
errorstringError message if failed
statementIdstringDatabricks statement ID
statusjsonStatement execution status
resultjsonDatabricks statement result payload
warehouseCountnumberNumber of visible SQL warehouses

Example

A minimal configuration for this block:

{
  "type": "databricks",
  "config": {
    "resource": "sql",
    "operation": "...",
    "statement": "..."
  }
}

Limits and failure modes

  • Requires a connected Databricks integration. Calls fail if that integration is disconnected or its authorization has expired.
  • Required fields (resource, operation, statement) must be set, or the block fails validation before it runs.
  • On failure the error output is populated; downstream blocks that reference other outputs may not receive values.

On this page