如何在dbt中为测试添加描述

Question

如何向通常用 yml 编写的通用测试添加描述，以便我可以在 dbt 文档的描述字段中看到它

在 yml 中，此类测试通常是这样编写的，但是如何向测试添加描述

        - name: desc
         description: "it is the description of the column but not the test"
          tests:
          - not_null:

Answer 1

要向 dbt .yml 文件中的通用测试添加描述，以便它显示在 dbt 文档中的

DESCRIPTION

字段中，您需要在测试定义中使用

description

字段。

以下是如何构建 YAML 的示例：

version: 2

models:
  - name: my_model
    columns:
      - name: my_column
        tests:
          - name: unique
            description: "Ensures that the values in this column are unique."
          - name: not_null
            description: "Ensures that the values in this column are not null."

当您运行

description

并查看文档时，您在测试中添加的

DESCRIPTION

字段现在将显示在

dbt docs generate

部分下。