Skip to main content

The Databricks adapter plugin for dbt

Reason this release was yanked:

Found an issue in oauth

Project description

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>=1.1.1 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, only available in dbt-databricks>=1.1.1]
      schema: [database/schema name]
      host: [your.databrickshost.com]
      http_path: [/sql/your/http/path]
      token: [dapiXXXXXXXXXXXXXXXXXXXXXXX]

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/..."
    )

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dbt-databricks-1.7.12.tar.gz (51.2 kB view details)

Uploaded Source

Built Distribution

dbt_databricks-1.7.12-py3-none-any.whl (64.8 kB view details)

Uploaded Python 3

File details

Details for the file dbt-databricks-1.7.12.tar.gz.

File metadata

  • Download URL: dbt-databricks-1.7.12.tar.gz
  • Upload date:
  • Size: 51.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for dbt-databricks-1.7.12.tar.gz
Algorithm Hash digest
SHA256 45d6b959640b29128f0dc272600db6f49c8507d196c2db6066a74324320c8c0d
MD5 af25c1f19ed5fe1dbc47a0010a29749c
BLAKE2b-256 35d28e16d6fb968f90d29cd681836de719dadbcd360da532bf87d0ff5f2f10ec

See more details on using hashes here.

File details

Details for the file dbt_databricks-1.7.12-py3-none-any.whl.

File metadata

File hashes

Hashes for dbt_databricks-1.7.12-py3-none-any.whl
Algorithm Hash digest
SHA256 99f4ff5af1a849d249f389ab8af390ab3689c49eab88d4ac128da787342741e2
MD5 fb5e3a8452692eaca2a51eae2930d91c
BLAKE2b-256 d7fedd05cf4bd62f473ba4b9cdd507a90e93ea8ef530db2427c6d085653b4de9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page