The dbt-snowflake transformer uses SQL to transform data stored in your warehouse.

Getting Started #

Prerequisites #

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration #

  1. Add the dbt-snowflake transformer to your project using meltano add :

    meltano add transformer dbt-snowflake
  2. Configure the settings below using meltano config .

Next steps #

Follow the remaining steps of the Getting Started guide:

  1. Transform loaded data for analysis
If you run into any issues, learn how to get help.

Settings #

Settings for dbt itself can be configured through dbt_project.yml as usual, which can be found at transform/dbt_project.yml in your Meltano project. dbt also has adapter-specific documentation for Snowflake.

The settings for transformer dbt-snowflake that are known to Meltano are documented below. To quickly find the setting you're looking for, use the Table of Contents at the top of the page.

Projects Directory (project_dir) #

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set project_dir <project_dir>

export DBT_SNOWFLAKE_PROJECT_DIR=<project_dir>

Profiles Directory (profiles_dir) #

  • Environment variable: DBT_PROFILES_DIR, alias: DBT_SNOWFLAKE_PROFILES_DIR
  • Default: $MELTANO_PROJECT_ROOT/transform/profiles/snowflake

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set profiles_dir <profiles_dir>

export DBT_PROFILES_DIR=<profiles_dir>

Account (account) #

The snowflake account to connect to.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set account <account>

export DBT_SNOWFLAKE_ACCOUNT=<account>

User (user) #

The user to connect as.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set user <user>

export DBT_SNOWFLAKE_USER=<user>

Password (password) #

The user password to authenticate with.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set password <password>

export DBT_SNOWFLAKE_PASSWORD=<password>

Role (role) #

The user role to assume.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set role <role>

export DBT_SNOWFLAKE_ROLE=<role>

Warehouse (warehouse) #

The compute warehouse to use when building models.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set warehouse <warehouse>

export DBT_SNOWFLAKE_WAREHOUSE=<warehouse>

Database (database) #

The database to create models in.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set database <database>

export DBT_SNOWFLAKE_DATABASE=<database>

Schema (schema) #

The schema to build models into by default.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-snowflake set schema <schema>

export DBT_SNOWFLAKE_SCHEMA=<schema>

Commands #

The dbt-snowflake transformer supports the following commands that can be used with meltano invoke :

clean #

  • Equivalent to: dbt clean

Delete all folders in the clean-targets list (usually the dbt_modules and target directories.)

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:clean [additional arguments...]

compile #

  • Equivalent to: dbt compile

Generates executable SQL from source model, test, and analysis files. Compiled SQL files are written to the target/ directory.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:compile [additional arguments...]

deps #

  • Equivalent to: dbt deps

Pull the most recent version of the dependencies listed in packages.yml

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:deps [additional arguments...]

run #

  • Equivalent to: dbt run

Compile SQL and execute against the current target database.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:run [additional arguments...]

seed #

  • Equivalent to: dbt seed

Load data from csv files into your data warehouse.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:seed [additional arguments...]

snapshot #

  • Equivalent to: dbt snapshot

Execute snapshots defined in your project.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:snapshot [additional arguments...]

test #

  • Equivalent to: dbt test

Runs tests on data in deployed models.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:test [additional arguments...]

freshness #

  • Equivalent to: dbt source freshness

Check the freshness of your source data.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:freshness [additional arguments...]

build #

  • Equivalent to: dbt build

Will run your models, tests, snapshots and seeds in DAG order.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:build [additional arguments...]

docs-generate #

  • Equivalent to: dbt docs generate

Generate documentation for your project.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:docs-generate [additional arguments...]

docs-serve #

  • Equivalent to: dbt docs serve

Serve documentation for your project. Make sure you ran docs-generate first.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:docs-serve [additional arguments...]

debug #

  • Equivalent to: dbt debug

Debug your DBT project and warehouse connection.

How to use #

Run this command using meltano invoke:

meltano invoke dbt-snowflake:debug [additional arguments...]

Looking for help? #

If you're having trouble getting the dbt-snowflake transformer to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the #plugins-general channel.

Found an issue on this page? #

This page is generated from a YAML file that you can contribute changes to. Edit it on GitHub!