如何在BigQuery Terraform视图中添加列描述：继承或直接设置

能否从源表继承列描述？ #

不行。BigQuery视图的元数据是独立于源表的，没有内置机制自动继承源表的列描述。哪怕源表的列描述后续更新，视图的列描述也不会同步变化。

如何手动设置视图列描述？ #

有两种常用方案，根据你的使用场景选择：

1. 在CREATE VIEW的SQL语句中直接指定 #

创建视图时，在列名后通过COMMENT子句添加描述，语法如下：

CREATE OR REPLACE VIEW `your-project.your-dataset.target-view` AS
SELECT
  source_col1 COMMENT '这是从源表复用的列1描述',
  source_col2 COMMENT '自定义的列2描述'
FROM `your-project.your-dataset.source-table`

2. 用Terraform配置视图Schema（适配你的现有工作流） #

因为你已经在用Terraform管理BigQuery表，推荐直接在google_bigquery_view资源中定义视图的Schema，明确指定列描述：

resource "google_bigquery_view" "user_view" {
  dataset_id = "your_dataset"
  table_id   = "user_summary_view"

  view {
    query = <<-SQL
      SELECT user_id, user_name, registration_date FROM `your-project.your-dataset.user_table`
    SQL

    schema = <<-JSON
      [
        {
          "name": "user_id",
          "type": "STRING",
          "description": "用户唯一标识ID"
        },
        {
          "name": "user_name",
          "type": "STRING",
          "description": "用户昵称"
        },
        {
          "name": "registration_date",
          "type": "DATE",
          "description": "用户注册日期"
        }
      ]
    JSON
  }
}

进阶：自动化继承源表描述（Terraform动态生成） #

如果想避免手动重复写描述，可以用Terraform的数据源拉取源表的Schema，动态生成视图的Schema，实现自动继承：

# 拉取源表的Schema元数据
data "google_bigquery_table" "source_user_table" {
  project    = "your-project"
  dataset_id = "your_dataset"
  table_id   = "user_table"
}

# 基于源表Schema动态生成视图
resource "google_bigquery_view" "auto_sync_view" {
  dataset_id = "your_dataset"
  table_id   = "auto_sync_user_view"

  view {
    # 动态生成SELECT语句，包含源表所有列
    query = <<-SQL
      SELECT ${join(", ", [for col in data.google_bigquery_table.source_user_table.schema.fields : col.name])}
      FROM `your-project.your-dataset.user_table`
    SQL

    # 从源表Schema中复用列名、类型、描述和模式
    schema = jsonencode([
      for col in data.google_bigquery_table.source_user_table.schema.fields : {
        name        = col.name
        type        = col.type
        description = col.description
        mode        = col.mode
      }
    ])
  }
}

这样源表的列描述更新后，执行terraform apply就能自动同步到视图的列描述中。

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