Skip to main content

databricks logo dbt logo

Unit Tests Badge Integration Tests Badge

dbt enables data analysts and engineers to transform their data using the same practices that software engineers use to build applications.

The Databricks Lakehouse provides one simple platform to unify all your data, analytics and AI workloads.

dbt-databricks

The dbt-databricks adapter contains all of the code enabling dbt to work with Databricks. This adapter is based off the amazing work done in dbt-spark. Some key features include:

  • Easy setup. No need to install an ODBC driver as the adapter uses pure Python APIs.
  • Open by default. For example, it uses the the open and performant Delta table format by default. This has many benefits, including letting you use MERGE as the the default incremental materialization strategy.
  • Support for Unity Catalog. dbt-databricks supports the 3-level namespace of Unity Catalog (catalog / schema / relations) so you can organize and secure your data the way you like.
  • Performance. The adapter generates SQL expressions that are automatically accelerated by the native, vectorized Photon execution engine.

Choosing between dbt-databricks and dbt-spark

If you are developing a dbt project on Databricks, we recommend using dbt-databricks for the reasons noted above.

dbt-spark is an actively developed adapter which works with Databricks as well as Apache Spark anywhere it is hosted e.g. on AWS EMR.

Getting started

Installation

Install using pip:

pip install dbt-databricks

Upgrade to the latest version

pip install --upgrade dbt-databricks

Profile Setup

your_profile_name:
  target: dev
  outputs:
    dev:
      type: databricks
      catalog: [optional catalog name, if you are using Unity Catalog]
      schema: [database/schema name]
      host: [your.databrickshost.com]
      http_path: [/sql/your/http/path]
      token: [dapiXXXXXXXXXXXXXXXXXXXXXXX]

Documentation

For documentation on Databricks-specific features, configurations, and capabilities:

Quick Starts

These following quick starts will get you up and running with the dbt-databricks adapter:

Compatibility

The dbt-databricks adapter has been tested:

  • with Python 3.7 or above.
  • against Databricks SQL and Databricks runtime releases 9.1 LTS and later.

Tips and Tricks

Choosing compute for a Python model

You can override the compute used for a specific Python model by setting the http_path property in model configuration. This can be useful if, for example, you want to run a Python model on an All Purpose cluster, while running SQL models on a SQL Warehouse. Note that this capability is only available for Python models.

def model(dbt, session):
    dbt.config(
      http_path="sql/protocolv1/..."
    )

Python models and ANSI mode

When ANSI mode is enabled (spark.sql.ansi.enabled=true), there are limitations when using pandas DataFrames in Python models:

  1. Regular pandas DataFrames: dbt-databricks will automatically handle conversion even when ANSI mode is enabled, falling back to spark.createDataFrame() if needed.

  2. pandas-on-Spark DataFrames: If you create pandas-on-Spark DataFrames directly in your model (using pyspark.pandas or databricks.koalas), you may encounter errors with ANSI mode enabled. In this case, you have two options:

    • Disable ANSI mode for your session: Set spark.sql.ansi.enabled=false in your cluster or SQL warehouse configuration
    • Set the pandas-on-Spark option in your model code:
      import pyspark.pandas as ps
      ps.set_option('compute.fail_on_ansi_mode', False)
      
      Note: This may cause unexpected behavior as pandas-on-Spark follows pandas semantics (returning null/NaN for invalid operations) rather than ANSI SQL semantics (raising errors).

For more information about ANSI mode and its implications, see the Spark documentation on ANSI compliance.

Metadata

Release files for dbt-databricks 1.12.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dbt-databricks 1.12.8
File Size Uploaded Provenance
dbt_databricks-1.12.8.tar.gz 123.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for dbt-databricks 1.12.8
File Interpreter ABI Platform
dbt_databricks-1.12.8-py3-none-any.whl Python 3 none any Details

Total release size: 305.7 kB

Release files / dbt_databricks-1.12.8.tar.gz

Download URL dbt_databricks-1.12.8.tar.gz
Size 123.8 kB
Tags Source
SHA-256 checksum
How to use checksums
42a177c80cb04ec38ebed8406dca948130c0302918de3d412b8fa304f427e5a2
BLAKE2b-256 checksum
How to use checksums
783956433aa09bdbae57b4b2638cc54ccd6d3f6289b29ea19cd2c64b785c11ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.22

Release files / dbt_databricks-1.12.8-py3-none-any.whl

Download URL dbt_databricks-1.12.8-py3-none-any.whl
Size 182.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f78866844ff2f4f419a5e67be3b6c138331d743390ae08fe574aa5836883e61c
BLAKE2b-256 checksum
How to use checksums
70f46b84a758c78a998c7dc636f79d07f0463c3d371d466eb5ecd36d91eff022
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.22

Security for dbt-databricks 1.12.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.12.8 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page