The dbt-postgres transformer is a plugin for running SQL-based transformations on data stored in your warehouse.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the dbt-postgres transformer to your
project using
:meltano add -
Configure the dbt-postgres
settings using
:meltano config
meltano add --plugin-type transformer dbt-postgresmeltano config dbt-postgres set --interactiveNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
This plugin currently has no capabilities defined. If you know the capabilities required by this plugin, please contribute!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 PostgreSQL.
The
dbt-postgres settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config dbt-postgres list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Database (dbname)
-
Environment variable:
DBT_POSTGRES_DBNAME
The db to connect to.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set dbname [value]Host (host)
-
Environment variable:
DBT_POSTGRES_HOST
The postgres host to connect to.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set host [value]Keep Alives Idle (keepalives_idle)
-
Environment variable:
DBT_POSTGRES_KEEPALIVES_IDLE
Seconds between TCP keepalive packets.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set keepalives_idle [value]Password (password)
-
Environment variable:
DBT_POSTGRES_PASSWORD
The password to connect with.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set password [value]Port (port)
-
Environment variable:
DBT_POSTGRES_PORT
The port to connect to.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set port [value]Profiles Directory (profiles_dir)
-
Environment variable:
DBT_POSTGRES_PROFILES_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform/profiles/postgres
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set profiles_dir [value]Projects Directory (project_dir)
-
Environment variable:
DBT_POSTGRES_PROJECT_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set project_dir [value]Role (role)
-
Environment variable:
DBT_POSTGRES_ROLE
Role for dbt to assume when executing queries.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set role [value]Schema (schema)
-
Environment variable:
DBT_POSTGRES_SCHEMA
The schema to use.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set schema [value]Search Path (search_path)
-
Environment variable:
DBT_POSTGRES_SEARCH_PATH
Overrides the default search path.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set search_path [value]SSL Mode (sslmode)
-
Environment variable:
DBT_POSTGRES_SSLMODE
SSL Mode used to connect to the database.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set sslmode [value]User (user)
-
Environment variable:
DBT_POSTGRES_USER
The user to connect as.
Configure this setting directly using the following Meltano command:
meltano config dbt-postgres set user [value]Commands
The dbt-postgres transformer supports the following commands that can be used withmeltano invokebuild
-
Equivalent to:
build
Will run your models, tests, snapshots and seeds in DAG order.
meltano invoke dbt-postgres:build [args...]clean
-
Equivalent to:
clean
Delete all folders in the clean-targets list (usually the dbt_modules and target directories.)
meltano invoke dbt-postgres:clean [args...]compile
-
Equivalent to:
compile
Generates executable SQL from source model, test, and analysis files. Compiled SQL files are written to the target/ directory.
meltano invoke dbt-postgres:compile [args...]debug
-
Equivalent to:
debug
Debug your DBT project and warehouse connection.
meltano invoke dbt-postgres:debug [args...]deps
-
Equivalent to:
deps
Pull the most recent version of the dependencies listed in packages.yml
meltano invoke dbt-postgres:deps [args...]docs-generate
-
Equivalent to:
docs generate
Generate documentation for your project.
meltano invoke dbt-postgres:docs-generate [args...]docs-serve
-
Equivalent to:
docs serve
Serve documentation for your project. Make sure you ran `docs-generate` first.
meltano invoke dbt-postgres:docs-serve [args...]freshness
-
Equivalent to:
source freshness
Check the freshness of your source data.
meltano invoke dbt-postgres:freshness [args...]run
-
Equivalent to:
run
Compile SQL and execute against the current target database.
meltano invoke dbt-postgres:run [args...]seed
-
Equivalent to:
seed
Load data from csv files into your data warehouse.
meltano invoke dbt-postgres:seed [args...]snapshot
-
Equivalent to:
snapshot
Execute snapshots defined in your project.
meltano invoke dbt-postgres:snapshot [args...]test
-
Equivalent to:
test
Runs tests on data in deployed models.
meltano invoke dbt-postgres:test [args...]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-brightgreen){kind=icon}
-76,105-c0c0c4){kind=icon}
-370-c0c0c4){kind=icon}
