What problem does it solve?
It solves the problem of uncertainty and friction when building or debugging Databricks integrations by giving a single, practical reference for configuring credentials, running Databricks Connect locally, and calling Databricks APIs via the Python SDK and REST when needed.
Core Features & Use Cases
- Environment and authentication guidance: Configure
DEFAULT profiles, ~/.databrickscfg, and required environment variables like DATABRICKS_HOST and DATABRICKS_TOKEN.
- Local development with Databricks Connect: Run Spark code locally while targeting a remote Databricks cluster without using an incompatible
.master("local[*]") setup.
- Programmatic API operations: Prefer
databricks-sdk-py methods for common tasks, and fall back to WorkspaceClient().api_client.do(...) for endpoints not yet covered or complex operations.
- CLI workflows: Use the Databricks CLI for operational checks (versioning, listings, workspace navigation) alongside SDK-based automation.
- API coverage reference: Covers major areas such as clusters, jobs, SQL statement execution, Unity Catalog (catalogs/schemas/tables/volumes), files, model serving, vector search, pipelines, and secrets, including key documentation link patterns.
Quick Start
Ask: "How do I authenticate with Databricks and run a SQL query using databricks-sdk-py against my warehouse?"