View as Markdown
Databricks (Service Principal) icon

Databricks (Service Principal) ACTION

Edit SQL Warehouse

Edits the configuration of an existing SQL Warehouse. 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 Edit 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-edit-sql-warehouse",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    databricks_oauth: { authProvisionId: "apn_xxxxxxx" },
    warehouseId: "Warehouse ID",
    name: "Warehouse Name",
  },
})

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.

Edit SQL Warehouse inputs
Property Type Description
warehouseId Warehouse ID string
The ID of the SQL Warehouse to edit
Required Dynamic
name Warehouse Name string
Logical name for the warehouse. Must be unique within an org and under 100 characters.
Optional
clusterSize Cluster Size string
Size of clusters allocated for this warehouse.
Optional
autoStopMins Auto Stop (minutes) integer
Minutes of inactivity before auto-stop. 0 disables autostop. Must be 0 or ≥ 10.
Optional
minNumClusters Min Number of Clusters integer
Minimum number of available clusters (> 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
Use Photon optimized clusters.
Optional
enableServerlessCompute Enable Serverless Compute boolean
Use serverless compute for this warehouse.
Optional
warehouseType Warehouse Type string
Set to PRO (recommended) or CLASSIC. Set PRO + enable serverless to use serverless.
Optional
spotInstancePolicy Spot Instance Policy string
Whether the warehouse should use spot instances.
Optional
tags Tags object
Key-value tags for all resources associated with this warehouse (fewer than 45 tags).
Optional
channel Channel object
Channel details. Example: { "name": "CHANNEL_NAME_CUSTOM", "dbsql_version": "2023.35" }
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-edit-sql-warehouse
Version
0.0.1
App
Databricks (Service Principal)
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes