Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.sqlbuild.com/llms.txt

Use this file to discover all available pages before exploring further.

Databricks requires the optional databricks-sql-connector dependency:
pip install 'sqlbuild[databricks]'
# or
uv add 'sqlbuild[databricks]'

Connection config

adapter: databricks

connection:
  server_hostname: my-workspace.cloud.databricks.com
  http_path: /sql/1.0/warehouses/abc123
  token: dapi_my_access_token
  catalog: my_catalog
  schema: my_schema
FieldDescription
server_hostnameDatabricks workspace hostname (required)
http_pathSQL warehouse or cluster HTTP path (required)
tokenPersonal access token (required)
catalogUnity Catalog name (required)
schemaDefault schema (optional)

Session initialization

On connect, SQLBuild runs USE CATALOG and USE SCHEMA statements to set the session context.