dbt-sugar audit
dbt-sugar audit
The audit
task allows you to get quick statistics about the documentation and testing coverage of your dbt project. It comes in two flavours: project- and model-level. For both flavours we report documentation coverage (the percentage of documented vs undocumented columns) and test coverage (the percentage of columns with at least one test on them). At the project-level we roll up those proportions across models to give you a summary of the state of the project and you can dig in more by running dbt-sugar audit
on a specific model.
New in v0.1.0.
You can now make audit generate placeholders for all your models first so that it is 100% accurate, by adding the --boostrap
CLI runtime argument.
NOTE: this has a side effect of generating a potentially large number of file changes and will be slower as calls have to be made to your database's information schema.
project-level audit
You can get a high-level overview of your dbt project's documentation and test coverage. You can get it by running the following command:
and you should get a report that looks something like this:
model-level audit
While the project-level audit is a quick way to get an overview of the documentation and test coverage quality of your models you may want to drill down on one specific model to get an output at the column level. To do so, you run the following command:
and you will get a report that looks like this:
Last updated