Skip to main content

Analysis properties

We recommend you define analysis properties in your analyses/ directory, which is illustrated in the analysis-paths configuration. Analysis properties are "special properties" in that you can't configure them in the dbt_project.yml file or using config() blocks. Refer to Configs and properties for more info.

You can name these files whatever_you_want.yml, and nest them arbitrarily deeply in subfolders within the analyses/ or models/ directory.

analyses/<filename>.yml
version: 2

analyses:
- name: <analysis_name> # required
description: <markdown_string>
docs:
show: true | false
node_color: <color_id> # Use name (such as node_color: purple) or hex code with quotes (such as node_color: "#cd7f32")
config:
tags: <string> | [<string>]
columns:
- name: <column_name>
description: <markdown_string>
- name: ... # declare properties of additional columns

- name: ... # declare properties of additional analyses

0