跳转至

字段描述维护

字段描述用于记录数据集字段的业务含义。可以集中维护描述,或从逻辑视图已有 SQL 的注释提取候选描述,比较差异后保存到 AIR 元数据。

前置条件与入口

打开“数据整合 → 数据空间”中的目标视图,在“概览”的字段列表点击“编辑”,进入“编辑字段描述”。该入口仅在当前数据集支持此功能且用户有修改权限时显示。

从 SQL 提取前,应先在视图定义中保存需要使用的注释;提取读取的是该数据集的 SQL,不是另一份未保存的工作簿草稿。通过模板批量维护多资产描述,仍使用元数据管理中的资产描述。

使用方法

  1. 在字段列表中搜索需要维护的字段,检查已有描述。
  2. 手动填写描述,或点击“从 SQL 提取”。
  3. 检查识别数量、已填充数量和差异数量。对于与现有描述不同的候选,逐项核对后采用或继续手工修改。
  4. 点击“保存”,重新打开字段列表确认内容。

提取结果先填入编辑表单,不会直接覆盖已保存元数据;最终以保存时的表单内容为准。没有变化时不会重复提交字段描述。

SQL 注释示例

SELECT
    -- 订单编号
    order_id,
    amount AS order_amount -- 订单金额
FROM sales.public.orders;

优先使用字段同行或上一行的注释,并为计算表达式设置明确别名。提取后仍需确认注释对应的输出字段,避免将源字段含义误用到加工结果。

注意事项与验证

  • 复杂嵌套、星号展开等 SQL 可能无法识别全部描述;“未识别”不表示字段不能查询,可手动补充。
  • 采用 SQL 候选前检查其业务含义和现有描述的差异,不应仅按识别数量判断正确性。
  • 修改描述不会改变字段类型、源端表结构或数据值,也不会自动刷新投影。
  • 保存后检查字段列表;如果内容不符,确认目标视图、字段别名及是否完成保存。