datnguye/dbterd

Column Descriptions

Closed this issue · 2 comments

Hi, want to start off by saying this is a very neat tool, trying to implement this into our workflow at work, but had one quick question.

Is there are particular reason/restricting factor that does not allow for you to pull in the column descriptions, and add them to the .dbml output, so that they show up on the db docs page?

Hi @agaddis02 Thanks for your suggestion.

Is there are particular reason/restricting factor that does not allow for you to pull in the column descriptions, and add them to the .dbml output, so that they show up on the db docs page?

This was one of considerations I wanted to add, but thinking that you could see the column/table description in dbt docs site already, it would be duplicated info.

In case you need this enabled in db docs site, I'm happy to mark this as new feature. This will poetentially open the door for another metadata flowing through e.g. tags, tests, groups (new in dbt 1.5), etc but let's focus on the description here.

In the meantime, I regret to inform that I will not have time to enable it soon (might take several weekends) due to my holiday plan next week. However, you will be more than welcome to submit a pull request instead, let me know if that's the case. Otherwise stay tune. Cheers!

Demo result as here

Release 1.2.0 (beta) is now available 🎉

pip install dbterd==1.2.0b1