Dataform声明添加列描述后未同步至BigQuery怎么办？

核心原因 #

你执行的是依赖order_table_1的erp1_order_staging.sqlx视图，但声明式对象（type: "declaration"）的元数据（表描述、列注释）更新不会通过依赖任务的执行自动触发，必须直接针对声明文件执行同步操作。

具体解决步骤 #

• 直接执行声明文件：在你的数据工具（如Dataform）中找到order_table_1.sqlx对应的任务，单独执行它，而非执行上游的视图任务。
• 确认执行选项：执行声明文件时，必须勾选元数据同步相关的选项（如"Update metadata"或"Sync descriptions"），这类选项负责将声明文件中的描述同步到BigQuery的表元数据中。
• 检查声明语法：部分数据工具（如Dataform的特定版本）要求列注释以对象形式定义，而非直接字符串，可调整为以下格式重试：

  config {
    type: "declaration",
    database: "database_name",
    schema: "schema",
    name: "order_table_1",
    description: "order_table_1 description",
    columns: {
      ORDERNO: { description: "Order Number" },
      CUSTNO: { description: "Customer Number" },
      AMOUNT: { description: "Order Amount" },
      QTYORD: { description: "Order Quantity" }
    }
  }
  

• 验证权限：确保执行任务的账号拥有BigQuery的bigquery.tables.update权限，该权限是修改表元数据的必要条件。

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