如何通过dbt为Databricks Unity Catalog中的Schema添加描述？

你提到的宏+on-run-end钩子确实是目前最直接的可行方案——因为dbt本身没有内置的Schema描述配置项，只能通过执行Databricks的DDL语句来实现。下面是具体的落地步骤：

1. 编写自定义宏 #

在dbt项目的macros目录下新建一个文件（比如set_schema_comment.sql），实现用于设置Schema描述的宏：

{% macro set_schema_comment(schema_full_name, comment_content) %}
  {% if comment_content %}
    ALTER SCHEMA {{ schema_full_name }} SET COMMENT '{{ comment_content | replace("'", "''") }}';
  {% endif %}
{% endmacro %}

这里做了两个关键处理：

• 先判断是否传入了有效描述，避免执行无意义的空COMMENT语句
• 用replace("'", "''")转义描述里的单引号，防止SQL语法报错

2. 配置on-run-end钩子调用宏 #

在项目根目录的dbt_project.yml中，通过on-run-end钩子指定dbt运行结束后要执行的宏。

单Schema场景 #

如果只需要给单个Schema加描述，直接写死参数即可：

on-run-end:
  - "{{ set_schema_comment('your_catalog.target_schema', '这是该Schema的业务描述：存储用户行为全量数据') }}"

多Schema批量处理场景 #

如果要给多个Schema批量设置描述，可以先在vars里定义描述映射，再遍历执行：
首先在dbt_project.yml的vars段添加配置：

vars:
  schema_comment_map:
    your_catalog.user_data: "存储用户注册、登录等核心行为数据"
    your_catalog.order_data: "存储订单创建、支付、履约全流程数据"

然后修改on-run-end钩子实现批量调用：

on-run-end:
  - "{% for schema, comment in var('schema_comment_map').items() %}{{ set_schema_comment(schema, comment) }};{% endfor %}"

3. 关键注意事项 #

• 确保dbt使用的Databricks账号拥有ALTER SCHEMA和USE SCHEMA权限，否则会执行失败
• 要保证目标Schema已经存在（可以通过dbt的schema配置提前创建，或手动执行CREATE SCHEMA语句）
• 描述里的特殊字符（比如单引号）已经通过宏自动转义，无需手动处理

内容的提问来源于stack exchange，提问作者Fábio Tavares