The dbt-bigquery 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-bigquery transformer to your
project using
:meltano add -
Configure the dbt-bigquery
settings using
:meltano config
meltano add --plugin-type transformer dbt-bigquerymeltano config dbt-bigquery 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 BigQuery.
The
dbt-bigquery 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-bigquery 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.
Authentication Method (auth_method)
-
Environment variable:
DBT_BIGQUERY_AUTH_METHOD
The auth method to use. One of: "oauth", "oauth-secrets", or "service-account"
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set auth_method [value]Client ID (client_id)
-
Environment variable:
DBT_BIGQUERY_CLIENT_ID
The client id to use, if authenticating via oauth-secrets method.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set client_id [value]Client Secret (client_secret)
-
Environment variable:
DBT_BIGQUERY_CLIENT_SECRET
The client secret to use, if authenticating via oauth-secrets method.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set client_secret [value] (dataset)
-
Environment variable:
DBT_BIGQUERY_DATASET
The dataset to use.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set dataset [value] (keyfile)
-
Environment variable:
DBT_BIGQUERY_KEYFILE
The path to the `keyfile.json`` to use, if authenticating via service-account method.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set keyfile [value]Profiles Directory (profiles_dir)
-
Environment variable:
DBT_BIGQUERY_PROFILES_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform/profiles/bigquery
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set profiles_dir [value]Project (project)
-
Environment variable:
DBT_BIGQUERY_PROJECT
The BigQuery project ID.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set project [value]Project Directory (project_dir)
-
Environment variable:
DBT_BIGQUERY_PROJECT_DIR -
Default Value:
$MELTANO_PROJECT_ROOT/transform
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set project_dir [value]Refresh Token (refresh_token)
-
Environment variable:
DBT_BIGQUERY_REFRESH_TOKEN
The refresh token, if authenticating via oauth-secrets method.
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set refresh_token [value]Token URI (token_uri)
-
Environment variable:
DBT_BIGQUERY_TOKEN_URI
The token redirect URI
Configure this setting directly using the following Meltano command:
meltano config dbt-bigquery set token_uri [value]Commands
The dbt-bigquery 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-bigquery:build [args...]clean
-
Equivalent to:
clean
Delete all folders in the clean-targets list (usually the dbt_modules and target directories.)
meltano invoke dbt-bigquery: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-bigquery:compile [args...]debug
-
Equivalent to:
debug
Debug your DBT project and warehouse connection.
meltano invoke dbt-bigquery:debug [args...]deps
-
Equivalent to:
deps
Pull the most recent version of the dependencies listed in packages.yml
meltano invoke dbt-bigquery:deps [args...]docs-generate
-
Equivalent to:
docs generate
Generate documentation for your project.
meltano invoke dbt-bigquery:docs-generate [args...]docs-serve
-
Equivalent to:
docs serve
Serve documentation for your project. Make sure you ran `docs-generate` first.
meltano invoke dbt-bigquery:docs-serve [args...]freshness
-
Equivalent to:
source freshness
Check the freshness of your source data.
meltano invoke dbt-bigquery:freshness [args...]run
-
Equivalent to:
run
Compile SQL and execute against the current target database.
meltano invoke dbt-bigquery:run [args...]seed
-
Equivalent to:
seed
Load data from csv files into your data warehouse.
meltano invoke dbt-bigquery:seed [args...]snapshot
-
Equivalent to:
snapshot
Execute snapshots defined in your project.
meltano invoke dbt-bigquery:snapshot [args...]test
-
Equivalent to:
test
Runs tests on data in deployed models.
meltano invoke dbt-bigquery: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}
-51,917-c0c0c4){kind=icon}
-93-c0c0c4){kind=icon}
