View as Markdown
Databricks (Service Principal) icon

Databricks (Service Principal) ACTION

Create SQL Warehouse

Creates a new SQL Warehouse in Databricks. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Databricks (Service Principal) account once, then configure and run Create SQL Warehouse from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "databricks_oauth-create-sql-warehouse",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    databricks_oauth: { authProvisionId: "apn_xxxxxxx" },
    name: "Warehouse Name",
    clusterSize: "Cluster Size",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Create SQL Warehouse inputs
Property Type Description
name Warehouse Name string
A human-readable name for the warehouse
Required
clusterSize Cluster Size string
Size of the cluster
Required
autoStopMinutes Auto Stop (minutes) integer
Minutes of inactivity before auto-stop. 0 disables auto-stop. Must be 0 or ≥ 10.
Optional
minNumClusters Min Number of Clusters integer
Minimum number of clusters to maintain (> 0 and ≤ min(max_num_clusters, 30)).
Optional
maxNumClusters Max Number of Clusters integer
Maximum number of clusters for autoscaler (≥ min_num_clusters and ≤ 30).
Optional
enablePhoton Enable Photon boolean
Whether the warehouse should use Photon optimized clusters.
Optional
enableServerlessCompute Enable Serverless Compute boolean
Whether the warehouse should use serverless compute.
Optional
warehouseType Warehouse Type string
Warehouse type: PRO or CLASSIC. Set PRO + enableServerlessCompute = true to use serverless.
Optional
spotInstancePolicy Spot Instance Policy string
Configures whether the warehouse should use spot instances.
Optional
channel Channel object
Channel details. Example: { "name": "CHANNEL_NAME_CUSTOM", "dbsql_version": "2023.35" }
Optional
tags Tags object
Custom key-value tags for resources associated with this SQL Warehouse. Example: { "environment": "prod", "team": "data-platform" }.
Optional
instanceProfileArn Instance Profile ARN (Deprecated) string
Deprecated. Instance profile used to pass IAM role to the cluster.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
databricks_oauth-create-sql-warehouse
Version
0.0.1
App
Databricks (Service Principal)
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes