Skip to main content

Analysis properties

(Applies to dbt v1.12 and later)

We recommend you define analysis properties in your analyses/ directory, which is illustrated in the analysis-paths configuration. 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

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

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

(Applies to dbt v1.12 and later)

To configure analyses at the project level, set the require_corrected_analysis_fqns flag to true and add an analyses block in your dbt_project.yml. The project-level configuration applies to existing analyses in the analyses/ folder — for example, setting +enabled: false disables them all.

dbt_project.yml
flags:
  require_corrected_analysis_fqns: true

analyses:
  +enabled: true | false

Was this page helpful?

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.

0