dbt-labs / dbt-project-evaluator

This package contains macros and models to find DAG issues automatically
https://dbt-labs.github.io/dbt-project-evaluator/latest/
Apache License 2.0
453 stars 69 forks source link

Add column documentation test(s) #492

Open shah204 opened 2 months ago

shah204 commented 2 months ago

Describe the feature

Add column documentation test(s) - # of models without full column documentation, and/or a column documentation coverage test that can be configured.

Describe alternatives you've considered

Additional context

n/a

Who will this benefit?

dbt projects looking to heavily enforce documentation as part of the development pipeline (us!)

Are you interested in contributing this feature?

Yes - I've never done so before but would love to try 😄

b-per commented 2 months ago

Hi!

We could somehow add this feature, but it might not be exactly what you are after.

The package only checks the columns that are added manually in the YAML files, NOT all the columns of a given model based on its SQL (e.g. not the list of columns you get in catalog.json after a dbt docs generate).

We have a callout in the docs here.

dylanvanw commented 3 weeks ago

Is there no way to also test column documentation for the given model based in its SQL?

That would be a very useful feature for this package.

b-per commented 3 weeks ago

No, as mentioned above, it is not possible today.