Column descriptions in dbt - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of column descriptions in dbt?

Column descriptions explain what each column in a table or model means. They help others understand the data clearly, like labels on jars in a kitchen.

beginner

How do you add a column description in a dbt model YAML file?

You add a description under the columns section in the YAML file like this:<br>

columns:<br>  - name: customer_id<br>    description: 'Unique ID for each customer'

beginner

Why are column descriptions important for data teams?

They make data easier to understand and use. This reduces mistakes and saves time when people explore or analyze data.

beginner

Can column descriptions be viewed in dbt documentation site?

Yes! When you run dbt docs generate and dbt docs serve, the descriptions appear in the documentation site next to each column.

beginner

What happens if you don’t provide a column description in dbt?

The column will show without explanation in the docs. This can confuse users who don’t know what the data means.

Where do you add column descriptions in dbt?

A In the model YAML file under columns

B Inside the SQL SELECT statement

C In the dbt_project.yml file

D In the profiles.yml file

Column descriptions belong in the model YAML file under the columns section.

What command shows column descriptions in a web page?

A dbt run

B dbt docs serve

C dbt test

D dbt compile

The command 'dbt docs serve' launches a local web server showing the documentation with column descriptions.

Why should you write clear column descriptions?

A To help users understand data easily

B To make SQL run faster

C To reduce file size

D To hide sensitive data

Clear descriptions help users understand what each column means, improving data use.

Which format is used to write column descriptions in dbt?

A CSV

B JSON

C XML

D YAML

dbt uses YAML files to define models and their column descriptions.

What happens if a column has no description in dbt docs?

A It causes an error

B It is hidden

C It shows without explanation

D It is automatically described

Columns without descriptions appear without explanation, which can confuse users.

Explain how to add and view column descriptions in dbt.

Think about where YAML files are and how dbt shows docs.

Why are column descriptions useful in a data project?

Imagine explaining data to a new teammate.