dbt-databricks 1.12.1

The Databricks adapter plugin for dbt

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 comprehensive documentation on Databricks-specific features, configurations, and capabilities:

• Databricks configurations - Complete reference for all Databricks-specific model configurations, materializations, and incremental strategies
• Connect to Databricks - Setup and authentication guide

Quick Starts

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

• Set up your dbt project with Databricks
• Using dbt Cloud with Databricks (Azure | AWS)
• Running dbt production jobs on Databricks Workflows
• Using Unity Catalog with dbt-databricks
• Continuous integration in dbt
• Loading data from S3 into Delta using the databricks_copy_into macro
• Contribute to this repository

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.