Skip to content

Scalefree's tool to automatically generate Data Vault models for the dbt package "datavault4dbt" based on metadata.

License

Notifications You must be signed in to change notification settings

ScalefreeCOM/turbovault4dbt

Repository files navigation

Welcome to TurboVault4dbt


What is TurboVault4dbt?

TurboVault4dbt is an open-source tool that automatically generates dbt models according to our datavault4dbt templates. It uses a metadata input of your Data Vault 2.0 from one of the supported databases and creates ready-to-process dbt-models.

What are the prerequisites to use TurboVault4dbt?

  • TurboVault4dbt requires a metadata analysis done by hand and stored in supported metadata storage.
  • Python must be installed as TurboVault4dbt is a software written in Python.

  • A dbt project is required to use the generated models.
  • Additionally, our dbt package datavault4dbt must be used since the dbt models are using datavault4dbt macros.

How does my metadata needs to look like?

You can find DDL scripts and templates for the metadata tables and the Excel sheet here]((https://github.com/ScalefreeCOM/turbovault4dbt/tree/main/metadata_ddl)).

Your metadata needs to be stored in the following tables/worksheets:

Where can I store my metadata?

Currently, TurboVault4dbt supports metadata input from

  • Snowflake
  • BigQuery
  • Google Sheets
  • Excel
  • SQLite DB Files

Our developers are constantly working on adding new connectors for more databases.

How do I install TurboVault4dbt?

To install TurboVault4dbt, follow the instructions on this page.

How do I connect TurboVault4dbt with my metadata?

You can configure the connection to your metadata storage in the config.ini. Further explanation for the configuration input can be found here.

How do I run TurboVault4dbt?

To run TurboVault4dbt, you need to install Python, as well as the required packages. Then, simply execute main.py, which will open a GUI that looks like this:

First, choose your metadata input platform where you have your metadata stored from the dropdown menu.

From the Sources section, choose the source objects that you would like to use. At least one source object should be selected.

From the Entities section, you can select which types of entities you want to generate. These are:

By using the checkboxes:

Now you can click on the START button and TurboVault4dbt will generate all necessary dbt models that work with datavault4dbt!

Releases

v2.0 (14.11.2024) - Current Version
v1.2 (18.09.2024)
v1.1.2 (23.01.2024)
v1.1.1 (24.05.2023)
v1.1.0 (22.05.2023)
v1.0.3 (16.02.2023)
v1.0.2 (13.02.2023)
v1.0.1 (30.01.2023)
v1.0.0 (26.01.2023)


Designed for

About

Scalefree's tool to automatically generate Data Vault models for the dbt package "datavault4dbt" based on metadata.

Resources

License

Stars

Watchers

Forks

Packages

No packages published