The dbt-redshift 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-redshift transformer to your project using meltano add :

    meltano add transformer dbt-redshift
  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 Redshift.

The settings for transformer dbt-redshift 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.

Project Directory (project_dir) #

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set project_dir <project_dir>

export DBT_REDSHIFT_PROJECT_DIR=<project_dir>

Profiles Directory (profiles_dir) #

  • Environment variable: DBT_PROFILES_DIR, alias: DBT_REDSHIFT_PROFILES_DIR
  • Default: $MELTANO_PROJECT_ROOT/transform/profiles/redshift

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set profiles_dir <profiles_dir>

export DBT_PROFILES_DIR=<profiles_dir>

Authentication Method (auth_method) #

The auth method to use (to use iam, set to “iam”. Omit to use password-based auth.)

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set auth_method <auth_method>

export DBT_REDSHIFT_AUTH_METHOD=<auth_method>

Cluster ID (cluster_id) #

The cluster id.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set cluster_id <cluster_id>

export DBT_REDSHIFT_CLUSTER_ID=<cluster_id>

Host (host) #

The host for the cluster.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set host <host>

export DBT_REDSHIFT_HOST=<host>

Password (password) #

The password, if using password-based auth.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set password <password>

export DBT_REDSHIFT_PASSWORD=<password>

User (user) #

The user to connect as.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set user <user>

export DBT_REDSHIFT_USER=<user>

Port (port) #

The port to connect to.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set port 1234

export DBT_REDSHIFT_PORT=1234

Database (dbname) #

The name of the db to connect to.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set dbname <dbname>

export DBT_REDSHIFT_DBNAME=<dbname>

Schema (schema) #

The schema to use.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set schema <schema>

export DBT_REDSHIFT_SCHEMA=<schema>

IAM Profile (iam_profile) #

The IAM profile to use.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set iam_profile <iam_profile>

export DBT_REDSHIFT_IAM_PROFILE=<iam_profile>

IAM Duration Seconds (iam_duration_seconds) #

Duration of the IAM session.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set iam_duration_seconds 1234

export DBT_REDSHIFT_IAM_DURATION_SECONDS=1234

Autocreate (autocreate) #

Whether or not to automatically create entities.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set autocreate true

export DBT_REDSHIFT_AUTOCREATE=true

Databse Groups (db_groups) #

Database groups to use.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set db_groups '[...]'

export DBT_REDSHIFT_DB_GROUPS='[...]'

Keep Alives Idle (keepalives_idle) #

Seconds between TCP keepalive packets

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set keepalives_idle 1234

export DBT_REDSHIFT_KEEPALIVES_IDLE=1234

Search Path (search_path) #

The search path to use (use of this setting is not recommended)

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set search_path <search_path>

export DBT_REDSHIFT_SEARCH_PATH=<search_path>

SSL Mode (sslmode) #

SSL MOde used to connect to Redshift.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set sslmode '[...]'

export DBT_REDSHIFT_SSLMODE='[...]'

RA3 Node (ra3_node) #

Enables cross-database sources.

How to use #

Manage this setting using meltano config or an environment variable:

meltano config dbt-redshift set ra3_node true

export DBT_REDSHIFT_RA3_NODE=true

Commands #

The dbt-redshift 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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift: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-redshift:debug [additional arguments...]

Looking for help? #

If you're having trouble getting the dbt-redshift 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!