Mats16 Briclaude Databricks SQL

Databricks SQL SDK

Guide for connecting to Databricks SQL Warehouse via SDK and executing queries.

Note: This skill assumes Serverless SQL Warehouse. Serverless warehouses spin up in seconds, so no need to handle startup wait times.

SDK Selection

Finding SQL Warehouses

Use Databricks CLI to list available SQL Warehouses:

# List all SQL Warehouses
databricks warehouses list

# Get details of a specific warehouse
databricks warehouses get <warehouse_id>

The http_path for connection is: /sql/1.0/warehouses/<warehouse_id>

Authentication

Use token authentication. For Databricks Apps, OAuth token is available from x-forwarded-access-token header.

# Python - Getting token in Databricks Apps
access_token = request.headers.get("x-forwarded-access-token")

// Node.js (Fastify) - Getting token in Databricks Apps
const accessToken = request.headers["x-forwarded-access-token"];

Quick Start

Python

from databricks import sql

with sql.connect(
    server_hostname="<workspace>.cloud.databricks.com",
    http_path="/sql/1.0/warehouses/<warehouse_id>",
    access_token="<token>"
) as conn:
    with conn.cursor() as cursor:
        cursor.execute("SELECT * FROM catalog.schema.table LIMIT 10")
        rows = cursor.fetchall()

Node.js

import { DBSQLClient } from "@databricks/sql";

const client = new DBSQLClient();
await client.connect({
  host: "<workspace>.cloud.databricks.com",
  path: "/sql/1.0/warehouses/<warehouse_id>",
  token: "<token>",
});

const session = await client.openSession();
const operation = await session.executeStatement("SELECT * FROM catalog.schema.table LIMIT 10");
const rows = await operation.fetchAll();

await operation.close();
await session.close();
await client.close();

Detailed Guides

• Python SDK Details: references/python-sdk.md - Connection options, parameter binding, large data processing
• Node.js SDK Details: references/nodejs-sdk.md - Async processing, streaming, Fastify integration
• Troubleshooting: references/troubleshooting.md - Connection errors, timeouts, authentication issues
• SQL Tips: references/sql-tips.md - Query optimization, best practices

Converted and distributed by TomeVault — claim your Tome and manage your conversions.