View as Markdown
Databricks (Service Principal) icon

Databricks (Service Principal) ACTION

Set SQL Warehouse Config

Updates the global configuration for SQL Warehouses. 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 Set SQL Warehouse Config 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-set-sql-warehouse-config",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    databricks_oauth: { authProvisionId: "apn_xxxxxxx" },
    instanceProfileArn: "Instance Profile ARN",
    googleServiceAccount: "Google Service Account",
  },
})

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.

Set SQL Warehouse Config inputs
Property Type Description
instanceProfileArn Instance Profile ARN string
Instance profile ARN used to pass an IAM role to clusters (AWS).
Optional
googleServiceAccount Google Service Account string
Service account email used for GCP workspaces, if applicable.
Optional
securityPolicy Security Policy string
Workspace-wide security policy for SQL Warehouses (if applicable).
Optional
channel Channel object
Channel details. Example: { "name": "CHANNEL_NAME_CUSTOM", "dbsql_version": "2023.35" }
Optional
enabledWarehouseTypes Enabled Warehouse Types string[]
Specify which warehouse types are enabled. Example item: { "warehouse_type": "PRO", "enabled": true }
Optional
configParam Config Parameters object
General config key/value pairs. Example item: { "key": "some.config", "value": "true" }
Optional
globalParam Global Parameters object
Global config key/value pairs applied to all warehouses.
Optional
sqlConfigurationParameters SQL Configuration Parameters object
SQL-specific configuration key/value pairs.
Optional
dataAccessConfig Data Access Config object
Key/value pairs for data access configuration (e.g., credentials passthrough, external storage access).
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-set-sql-warehouse-config
Version
0.0.1
App
Databricks (Service Principal)
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes