dbt-artifacts - Meltano Hub

dbt Artifacts

dbt-artifacts (matatika variant)

A tool for processing dbt artifacts.

The dbt-artifacts utility is a tool for processing dbt artifacts, such as to generate model lineage in diagram-as-code files.

WARNING: This extension is currently in beta - if you run into any problems, join the Matatika Slack community and ask for help in the #troubleshooting channel.

EDK Based Plugin

This utility is based on the Meltano Extension Developer Kit (EDK) which is the preferred way to build and add non-Singer plugins to Meltano Hub. For more information about the EDK, please read this section of the Meltano docs. If you have any feedback or suggestions, add them to the EDK repo.

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

Installation and configuration

Add the dbt-artifacts utility to your project using
```
meltano add
```
:

meltano add utility dbt-artifacts

Configure the dbt-artifacts settings using

meltano config

meltano config dbt-artifacts set --interactive

Next steps

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

The dbt-artifacts 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:

output_dir
resource_types
source_dir

You can also list these settings using

meltano config

with the list subcommand:

meltano config dbt-artifacts 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.

Output directory (output_dir)

Environment variable: DBT_ARTIFACTS_OUTPUT_DIR
Default Value: output

Output directory for processed artifacts.

Configure this setting directly using the following Meltano command:

meltano config dbt-artifacts set output_dir [value]

Resource types (resource_types)

Environment variable: DBT_ARTIFACTS_RESOURCE_TYPES
Default Value: ["all"]

The dbt resource types to process (source, model, snapshot, test, or all).

Configure this setting directly using the following Meltano command:

meltano config dbt-artifacts set resource_types [value]

Source directory (source_dir)

Environment variable: DBT_ARTIFACTS_SOURCE_DIR
Default Value: .meltano/transformers/dbt/target

Source directory for the dbt artifact files.

Configure this setting directly using the following Meltano command:

meltano config dbt-artifacts set source_dir [value]

Commands

The dbt-artifacts utility supports the following commands that can be used with

meltano invoke

convert-matatika

Equivalent to: convert --format matatika

Convert artifacts to Matatika datasets.

meltano invoke dbt-artifacts:convert-matatika [args...]

convert-mermaid

Equivalent to: convert --format mermaid

Convert artifacts to Mermaid entity-relationship diagrams.

meltano invoke dbt-artifacts:convert-mermaid [args...]

For help, try meltano invoke dbt-artifacts --help (or --help on any subcommand).

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the dbt-artifacts utility 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.

Install

meltano add utility dbt-artifacts

Maintenance Status

Repo

https://github.com/Matatika/dbt-artifacts-ext

EDK Extension Repo

Maintainer

Meltano Stats

Keywords