 | dbt PostgreSQL (EDK preview)
|
The dbt-postgres
utility is an adapter-specific dbt transformer for running SQL-based transformations on data stored in your warehouse. This utility is in a preview stage of readiness. It is based upon our Extension Developer Kit (EDK) which is the new way to build and add plugins to Meltano Hub.
This preview of dbt will replace the native transformer once it comes out of preview. In the meantime, we would appreciate any feedback in the EDK repo and in the dbt Extension repo.EDK Preview
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the dbt-postgres utility to your project
using
:meltano add -
Configure the dbt-postgres settings using
:meltano config
meltano add utility dbt-postgresmeltano config dbt-postgres set --interactiveNext steps
- If you're running dbt for the first time in a new environment:
# create a starter dbt_project.yml file, a profiles.yml file, and models directory
meltano invoke dbt-postgres:initialize
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:
skip_pre_invoketypeproject_dirprofiles_dirhostuserpasswordportdbnameschemakeepalives_idlesearch_pathrolesslmode
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.
Skip Pre-invoke (skip_pre_invoke)
-
Environment variable:
DBT_POSTGRES_SKIP_PRE_INVOKE -
Default Value:
false
Whether to skip pre-invoke hooks which automatically run dbt clean and deps
dbt Profile type (type)
-
Environment variable:
DBT_POSTGRES_TYPE -
Default Value:
postgres
Projects Directory (project_dir)
-
Environment variable:
DBT_POSTGRES_PROJECT_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform
Profiles Directory (profiles_dir)
-
Environment variable:
DBT_POSTGRES_PROFILES_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform/profiles/postgres
Host (host)
-
Environment variable:
DBT_POSTGRES_HOST
The postgres host to connect to.
User (user)
-
Environment variable:
DBT_POSTGRES_USER
The user to connect as.
Password (password)
-
Environment variable:
DBT_POSTGRES_PASSWORD
The password to connect with.
Port (port)
-
Environment variable:
DBT_POSTGRES_PORT
The port to connect to.
Database (dbname)
-
Environment variable:
DBT_POSTGRES_DBNAME
The db to connect to.
Schema (schema)
-
Environment variable:
DBT_POSTGRES_SCHEMA
The schema to use.
Keep Alives Idle (keepalives_idle)
-
Environment variable:
DBT_POSTGRES_KEEPALIVES_IDLE
Seconds between TCP keepalive packets.
Search Path (search_path)
-
Environment variable:
DBT_POSTGRES_SEARCH_PATH
Overrides the default search path.
Role (role)
-
Environment variable:
DBT_POSTGRES_ROLE
Role for dbt to assume when executing queries.
SSL Mode (sslmode)
-
Environment variable:
DBT_POSTGRES_SSLMODE
SSL Mode used to connect to the database.
Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-generalInstall
meltano add utility dbt-postgresMaintenance Status
-brightgreen){kind=icon}
Maintainer
Meltano Stats
-6475-c0c0c4){kind=icon}
-128-c0c0c4){kind=icon}
Keywords
