dbt-materialize 0.21.0

The Materialize adapter plugin for dbt (data build tool).

dbt-materialize

dbt adapter for Materialize.

Note: this plugin is a work in progress, and not yet suitable for production.

Installation

This package can be installed via pip:

pip install dbt-materialize

or locally from the Materialize Github repository:

git clone https://github.com/MaterializeInc/materialize
pip install materialize/dbt-materialize

Configuring your profile

Materialize is based on the Postgres database protocols, so use the dbt postgres settings in your connection profile, with the following alterations:

• type: materialize
• user: materialize

Complete sample profiles can be found in sample_profiles.yml.

Supported Features

Materializations

Type	Supported?	Details
source	YES	Creates a source.
view	YES	Creates a view.
materializedview	YES	Creates a materialized view.
table	YES	Creates a materialized view. (Actual table support pending #5266)
index	YES	Creates an index.
sink	YES	Creates a sink.
ephemeral	YES	Executes queries using CTEs.
incremental	NO	Use the materializedview materialization instead! dbt's incremental models are valuable because they only spend your time and money transforming your new data as it arrives. Luckily, this is exactly what Materialize's materialized views were built to do! Better yet, our materialized views will always return up-to-date results without manual or configured refreshes. For more information, check out our documentation.

Additional macros

Macro	Purpose
mz_generate_name(identifier)	Generates a fully-qualified name (including the database and schema) given an object name.

Seeds

dbt seed will create a static materialized view from a CSV file. You will not be able to add to or update this view after it has been created.

Hooks

Not tested.

Custom Schemas

Not tested.

Sources

Not tested.

Testing and Documentation

dbt docs and dbt test commands are supported.

Snapshots

Not supported, will likely not be supported in the near term.

Contributors

A huge thank you to Josh Wills, who originally created this adapter.