The tap-dbt extractor pulls data from dbt Cloud that can then be sent to a destination using a loader.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-dbt extractor to your
project using
:meltano add -
Configure the tap-dbt
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-dbtmeltano config tap-dbt set --interactivemeltano config tap-dbt testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-dbt
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- batch
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-dbt 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 tap-dbt 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.
Account IDs (account_ids)
-
Environment variable:
TAP_DBT_ACCOUNT_IDS
dbt Cloud account IDs
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set account_ids [value]API Key (api_key)
-
Environment variable:
TAP_DBT_API_KEY
API key for the dbt Cloud API
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set api_key [value]Base URL (base_url)
-
Environment variable:
TAP_DBT_BASE_URL -
Default Value:
https://cloud.getdbt.com/api/v2
Base URL for the dbt Cloud API
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set base_url [value]Page Size (page_size)
-
Environment variable:
TAP_DBT_PAGE_SIZE -
Default Value:
5000
Page size to use in limit= url parameter
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set page_size [value]User Agent (user_agent)
-
Environment variable:
TAP_DBT_USER_AGENT -
Default Value:
tap-dbt/0.12.3.post1 Singer tap for the dbt Cloud API.
User-Agent to make requests with
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set user_agent [value]Expand To Show SDK Settings
Batch Config Encoding Compression (batch_config.encoding.compression)
-
Environment variable:
TAP_DBT_BATCH_CONFIG_ENCODING_COMPRESSION
Compression format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set batch_config encoding.compression [value]Batch Config Encoding Format (batch_config.encoding.format)
-
Environment variable:
TAP_DBT_BATCH_CONFIG_ENCODING_FORMAT
Format to use for batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set batch_config encoding.format [value]Batch Config Storage Prefix (batch_config.storage.prefix)
-
Environment variable:
TAP_DBT_BATCH_CONFIG_STORAGE_PREFIX
Prefix to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set batch_config storage.prefix [value]Batch Config Storage Root (batch_config.storage.root)
-
Environment variable:
TAP_DBT_BATCH_CONFIG_STORAGE_ROOT
Root path to use when writing batch files.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set batch_config storage.root [value]Faker Config Locale (faker_config.locale)
-
Environment variable:
TAP_DBT_FAKER_CONFIG_LOCALE
One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set faker_config locale [value]Faker Config Seed (faker_config.seed)
-
Environment variable:
TAP_DBT_FAKER_CONFIG_SEED
Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set faker_config seed [value]Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_DBT_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_DBT_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_DBT_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_DBT_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-dbt set stream_maps [value]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}
-115-c0c0c4){kind=icon}
-5-c0c0c4){kind=icon}
