Home

Awesome

<div align="center"> <img alt="logo" data-is-relative="true" src="./assets/img/logo.png" width="250" height="250"/> <h1>dbt-toolkit 🧰</h1> <img alt="GitHub Workflow Status" src="https://github.com/ramonvermeulen/dbt-toolkit/actions/workflows/build.yml/badge.svg?branch=main"> <a href="https://codecov.io/github/ramonvermeulen/dbt-toolkit" ><img src="https://codecov.io/github/ramonvermeulen/dbt-toolkit/graph/badge.svg?token=E0ATR13F60"/></a> <a href="https://plugins.jetbrains.com/plugin/24666-dbttoolkit"><img alt="JetBrains Plugin Version" src="https://img.shields.io/jetbrains/plugin/v/24666-dbttoolkit"></a> <a href="https://plugins.jetbrains.com/plugin/24666-dbttoolkit"><img alt="JetBrains Plugin Downloads" src="https://img.shields.io/jetbrains/plugin/d/24666-dbttoolkit"></a> <a href="https://github.com/ramonvermeulen/dbt-toolkit"><img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/ramonvermeulen/dbt-toolkit"></a> </div> <br>

Lineage Example

<!-- Plugin description -->

The dbt-toolkit is an early-stage plugin designed to enhance your experience working with dbt-core projects within JetBrains IDEs. It currently supports lineage rendering, dbt documentation, compiled SQL preview, and more! Providing a more streamlined and integrated approach to managing your dbt projects in Jetbrains IDEs. The dbt-toolkit is inspired by the well-known VSCode plugin vscode-dbt-power-user, and aims to become an alternative for JetBrains IDEs.

Note: For larger dbt projects (e.g. hundreds of models) the performance might not be as good, I am looking for ways to improve the performance even for larger dbt projects.

Features

Upcoming Features

These are features I am planning to implement in the future, however this list might change overtime

Prerequisites

If there is a venv configured within the IDE, the plugin will automatically try to use the dbt executable from the venv. If there is no venv configured the plugin will use the globally installed dbt version.

Installation

You can download dbt-toolkit from the JetBrains plugin marketplace. For more information on how to install JetBrains plugins, please refer to the official documentation.

Setting environment variables

If your dbt project requires environment variables (e.g. DBT_SOME_ENV_VAR), please set them via the plugin settings. File > Settings > dbtToolkit > Environment Variables

There is also support for .env files, the plugin automatically checks for a .env file in the root of your project. Via the plugin settings, you can also specify a custom path to the .env file.

Note: The global plugin environment variables will overwrite any environment variable with the same key in your .env files

<!-- Plugin description end -->

Releases

The releases can be found under the repository it's releases section, the latest release in Github doesn't always reflect the latest release in the Jetbrains Marketplace. The reason for this is that the Jetbrains Marketplace needs a couple of days to review a release before publishing. If you really need to be on the latest release you can always download the zip file (e.g. dbt-toolkit-<version>.zip and in the IDE Plugin window choose for Install from disk.

Feedback and Contributions

I highly appreciate any feedback and contributions as I am developing and improving dbt-toolkit. Feel free to report bugs, issues, or suggest features through the GitHub repository.

Troubleshooting

Experiencing issues after upgrading the plugin? Try to delete your .idea/dbtToolkitSettings.xml file. If you're still experiencing problems, feel free to open a Github issue and I'll try to investigate and solve the issue in a future release.


Plugin based on the IntelliJ Platform Plugin Template.