如何在BigQuery视图中添加并保留作者、创建日期等注释？

问题说明 #

你提到通过BigQuery UI创建视图时，SQL语句里的注释（比如示例中的-- this is my important comment...）不会被保留展示——确实，BigQuery UI创建视图时不会将这类SQL注释存入视图元数据，要实现保留作者、创建日期这类注释的需求，得用以下几种方法：

实现方式 #

1. 用SQL语句添加视图级注释（支持UI执行、bq客户端、Python） #

BigQuery支持通过ALTER VIEW语句给视图添加正式的元数据注释，这类注释会在UI的视图详情页显示，也能通过API查询到。

操作步骤：

• 先创建视图（UI或SQL方式均可）：

CREATE OR REPLACE VIEW `my_project_id.my_dataset.my_view_name`
AS
SELECT 1 as column_a;

• 执行ALTER VIEW添加包含作者、日期的注释：

ALTER VIEW `my_project_id.my_dataset.my_view_name`
SET OPTIONS(
  description = '作者: 张三\n创建日期: 2024-05-20\n备注: 测试视图，用于演示注释持久化功能'
);

执行完成后，在BigQuery UI点击视图名称进入详情页，就能看到这些描述信息。

2. 通过bq命令行客户端添加 #

直接用bq update命令设置视图描述，示例：

bq update --description "作者: 张三\n创建日期: 2024-05-20\n备注: 测试视图" my_project_id:my_dataset.my_view_name

格式支持项目ID:数据集.视图名或完整的项目ID.数据集.视图名。

3. 通过Python客户端（BigQuery API）添加 #

使用Google Cloud的BigQuery Python库，调用update_table方法设置视图描述：

from google.cloud import bigquery

client = bigquery.Client()

# 定位目标视图
view_ref = client.dataset("my_dataset", project="my_project_id").table("my_view_name")
view = client.get_table(view_ref)

# 设置包含作者、日期的注释
view.description = """作者: 张三
创建日期: 2024-05-20
备注: 测试视图，用于演示注释持久化功能"""

# 更新视图元数据
client.update_table(view, ["description"])

补充说明 #

• 你最初在CREATE VIEW里写的-- ...属于SQL语句的临时注释，BigQuery不会将其保存为视图元数据，所以UI不会展示。只有通过SET OPTIONS（SQL）、bq update或API设置的description才会被持久化存储。
• 如果需要给视图列添加注释，也可以在创建视图时指定：

CREATE OR REPLACE VIEW `my_project_id.my_dataset.my_view_name`(
  column_a INT64 OPTIONS(description="测试用列A")
)
AS
SELECT 1 as column_a;

内容的提问来源于stack exchange，提问作者Sander van den Oord