如何为dbt中yml定义的通用测试添加描述以在dbt docs展示

要让测试说明展示在dbt docs对应测试的DESCRIPTION字段，只需要在测试的配置层级下添加description属性即可，注意不要把测试描述写在列（column）的description属性下——后者只会作为字段本身的说明展示，不会关联到绑定的测试。

正确写法示例 #

你可以参考如下格式调整你的yml配置：

version: 2
models:
  - name: 你的目标模型名称
    columns:
      - name: desc
        description: "这是字段本身的描述，不会展示在测试说明中"
        tests:
          - not_null:
              description: "该校验规则要求desc字段不允许出现空值，若校验失败需排查上游数据产出逻辑，过滤空值数据"
          # 其他测试按相同格式加描述即可
          - unique:
              description: "该校验规则要求desc字段全局唯一，若校验失败说明存在重复取值，违反字段唯一性约束"

注意事项 #

• 缩进别写错：测试的description要比测试名（比如示例里的not_null）多缩进2格，和你平时给测试加筛选条件、阈值配置的层级保持一致，缩错位了配置读不到，描述就不会显示。
• 改完yml别忘重新跑dbt docs generate生成新的文档静态文件，刷新页面之后就能看到测试详情页的DESCRIPTION栏填上了你写的说明，不会再是空的。

内容的提问来源于stack exchange，提问作者Aliaksandra