更新标签

本页介绍如何更新 BigQuery 资源上的标签。

更新数据集标签

数据集标签可通过以下方式更新:

  • 使用 Cloud Console 或经典版 BigQuery 网页界面
  • 使用命令行工具的 bq update 命令
  • 调用 datasets.patch API 方法
  • 使用客户端库

所需权限

如需更新数据集标签,您至少必须获得 bigquery.datasets.update 权限。以下预定义 Cloud IAM 角色可提供 bigquery.datasets.update 权限:

  • bigquery.dataOwner
  • bigquery.admin

此外,如果用户具有 bigquery.datasets.create 权限,则当该用户创建数据集时,系统会为其授予该数据集的 bigquery.dataOwner 访问权限。借助 bigquery.dataOwner 访问权限,用户可更新数据集上的标签。

如需详细了解 BigQuery 中的 IAM 角色和权限,请参阅预定义的角色和权限

更新数据集标签

要更新数据集上的标签,请执行以下操作:

控制台

  1. 在 Cloud Console 中,选择相应的数据集。

  2. 在数据集详情页面上,点击标签右侧的铅笔图标。

    标签铅笔

  3. 修改标签对话框中执行以下操作:

    • 要应用更多标签,请点击添加标签。每个键只能在每个数据集内使用一次,但您可以在同一项目的不同数据集内使用同一个键。
    • 修改现有键或值以更新标签。
    • 点击更新以保存更改。

经典版界面

  1. 在网页界面,选择相应的数据集。

  2. Dataset Details 页面,点击 Labels 右侧的 Edit。

    修改标签

  3. Edit Labels 对话框中执行以下操作:

    • 要应用更多标签,请点击 Add Label。每个键只能在每个数据集内使用一次,但您可以在同一项目的不同数据集内使用同一个键。
    • 修改现有键或值以更新标签。
    • 点击 OK

      新标签

CLI

要添加其他标签或更新数据集标签,请发出带 set_label 标志的 bq update 命令。重复使用该标志可添加或更新多个标签。

如果数据集属于非默认项目,请按以下格式将相应的项目 ID 添加到数据集:[PROJECT_ID]:[DATASET]

bq update \
--set_label key:value \
project_id:dataset

其中:

  • key:value 对应于要添加或更新的标签的键值对。如果您指定与现有标签相同的键,则系统会更新现有标签的值。键必须是唯一的。
  • project_id 是您的项目 ID
  • dataset 是要更新的数据集

示例:

要更新 mydatasetdepartment 标签,请输入 bq update 命令并将 department 指定为标签键。例如,要将 department:shipping 标签更新为 department:logistics,请输入以下命令。mydataset 属于 myotherproject,而非默认项目。

    bq update \
    --set_label department:logistics \
    myotherproject:mydataset

输出如下所示。

Dataset 'myotherproject:mydataset' successfully updated.

API

要添加其他标签或更新现有数据集的标签,请调用 datasets.patch 方法,然后为数据集资源添加或更新 labels 属性。

由于 datasets.update 方法会替换整个数据集资源,因此最好使用 datasets.patch 方法。

Go

尝试此示例之前,请按照 BigQuery 快速入门:使用客户端库中的 Go 设置说明进行操作。如需了解详情,请参阅 BigQuery Go API 参考文档

import (
	"context"
	"fmt"

	"cloud.google.com/go/bigquery"
)

// addDatasetLabel demonstrates adding label metadata to an existing dataset.
func addDatasetLabel(projectID, datasetID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}

	ds := client.Dataset(datasetID)
	meta, err := ds.Metadata(ctx)
	if err != nil {
		return err
	}

	update := bigquery.DatasetMetadataToUpdate{}
	update.SetLabel("color", "green")
	if _, err := ds.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

Java

此示例使用 Java 版 Google HTTP 客户端库向 BigQuery API 发送请求。

尝试此示例之前,请按照《BigQuery 快速入门:使用客户端库》中的 Java 设置说明进行操作。如需了解详情,请参阅 BigQuery Java API 参考文档

static final HttpTransport HTTP_TRANSPORT = new NetHttpTransport();
static final JsonFactory JSON_FACTORY = new JacksonFactory();

public static class Dataset {
  @Key private Map<String, String> labels;

  public Map<String, String> getLabels() {
    return this.labels;
  }

  public Dataset addLabel(String key, String value) {
    if (this.labels == null) {
      this.labels = new HashMap<>();
    }
    this.labels.put(key, value);
    return this;
  }
}

/**
 * Add or modify a label on a dataset.
 *
 * <p>See <a href="https://cloud.google.com/bigquery/docs/labeling-datasets">the BigQuery
 * documentation</a>.
 */
public static void labelDataset(
    String projectId, String datasetId, String labelKey, String labelValue) throws IOException {

  // Authenticate requests using Google Application Default credentials.
  GoogleCredential credential = GoogleCredential.getApplicationDefault();
  credential = credential.createScoped(Arrays.asList("https://www.googleapis.com/auth/bigquery"));

  // Get a new access token.
  // Note that access tokens have an expiration. You can reuse a token rather than requesting a
  // new one if it is not yet expired.
  credential.refreshToken();
  String accessToken = credential.getAccessToken();

  // Set the content of the request.
  Dataset dataset = new Dataset();
  dataset.addLabel(labelKey, labelValue);
  HttpContent content = new JsonHttpContent(JSON_FACTORY, dataset);

  // Send the request to the BigQuery API.
  String urlFormat =
      "https://www.googleapis.com/bigquery/v2/projects/%s/datasets/%s"
          + "?fields=labels&access_token=%s";
  GenericUrl url = new GenericUrl(String.format(urlFormat, projectId, datasetId, accessToken));
  HttpRequestFactory requestFactory = HTTP_TRANSPORT.createRequestFactory();
  HttpRequest request = requestFactory.buildPostRequest(url, content);
  request.setParser(JSON_FACTORY.createJsonObjectParser());

  // Workaround for transports which do not support PATCH requests.
  // See: http://stackoverflow.com/a/32503192/101923
  request.setHeaders(new HttpHeaders().set("X-HTTP-Method-Override", "PATCH"));
  HttpResponse response = request.execute();

  // Check for errors.
  if (response.getStatusCode() != 200) {
    throw new RuntimeException(response.getStatusMessage());
  }

  Dataset responseDataset = response.parseAs(Dataset.class);
  System.out.printf(
      "Updated label \"%s\" with value \"%s\"\n",
      labelKey, responseDataset.getLabels().get(labelKey));
}

Node.js

尝试此示例之前,请按照 BigQuery 快速入门:使用客户端库中的 Node.js 设置说明进行操作。如需了解详情,请参阅 BigQuery Node.js API 参考文档

// Import the Google Cloud client library
const {BigQuery} = require('@google-cloud/bigquery');
const bigquery = new BigQuery();

async function labelDataset() {
  // Updates a label on a dataset.

  /**
   * TODO(developer): Uncomment the following lines before running the sample
   */
  // const datasetId = "my_dataset";

  // Retrieve current dataset metadata.
  const dataset = bigquery.dataset(datasetId);
  const [metadata] = await dataset.getMetadata();

  // Add label to dataset metadata
  metadata.labels = {color: 'green'};
  const [apiResponse] = await dataset.setMetadata(metadata);

  console.log(`${datasetId} labels:`);
  console.log(apiResponse.labels);
}

Python

尝试此示例之前,请按照《BigQuery 快速入门:使用客户端库》中的 Python 设置说明进行操作。如需了解详情,请参阅 BigQuery Python API 参考文档

# TODO(developer): Import the client library.
# from google.cloud import bigquery

# TODO(developer): Construct a BigQuery client object.
# client = bigquery.Client()

# TODO(developer): Set dataset_id to the ID of the dataset to fetch.
# dataset_id = "your-project.your_dataset"

dataset = client.get_dataset(dataset_id)  # Make an API request.
dataset.labels = {"color": "green"}
dataset = client.update_dataset(dataset, ["labels"])  # Make an API request.

print("Labels added to {}".format(dataset_id))

更新表和视图标签

创建表或视图后,可通过以下方式更新标签:

  • 使用 Cloud Console 或经典版 BigQuery 网页界面
  • 使用命令行工具的 bq update 命令
  • 调用 tables.patch API 方法
    • 由于视图被视为表资源,因此您可以使用 tables.patch 方法来修改视图和表。
  • 使用客户端库

所需权限

如需更新表标签或视图标签,您至少必须具有 bigquery.tables.update 权限。以下预定义 Cloud IAM 角色可提供 bigquery.tables.update 权限:

  • bigquery.dataEditor
  • bigquery.dataOwner
  • bigquery.admin

此外,如果用户具有 bigquery.datasets.create 权限,则当该用户创建数据集时,系统会为其授予该数据集的 bigquery.dataOwner 访问权限。借助 bigquery.dataOwner 访问权限,用户可更新数据集上的标签以及这些数据集中的表和视图。

如需详细了解 BigQuery 中的 Cloud IAM 角色和权限,请参阅预定义的角色和权限

更新表或视图标签

要更新表或视图标签,请执行以下操作:

控制台

  1. 在 Cloud Console 中,选择相应的表或视图。

  2. 点击详细信息标签页,然后点击标签右侧的铅笔图标。

  3. 修改标签对话框中:

    • 要应用更多标签,请点击添加标签。每个键只能在每个表或视图内使用一次,但您可以在不同数据集内的表或视图中使用同一个键。
    • 修改现有键或值以更新标签。
    • 点击更新以保存更改。

经典版界面

  1. 在网页界面,选择表或视图。

  2. 在详情页面,点击 Labels 右侧的 Edit。以下示例展示了表的详细信息。

    修改标签

  3. Edit Labels 对话框中执行以下操作:

    • 要添加更多标签,请点击 Add Label。每个键只能在每个表或视图内使用一次,但您可以在不同数据集内的表或视图中使用同一个键。
    • 修改现有键或值以更新标签。
    • 点击 OK

      新标签

CLI

要添加其他标签或更新表或视图标签,请发出带 set_label 标志的 bq update 命令。重复使用该标志可添加或更新多个标签。

如果表或视图属于非默认项目,请按以下格式将相应的项目 ID 添加到数据集:project_id:dataset

bq update \
--set_label key:value \
project_id:dataset.table_or_view

其中:

  • key:value 对应于要添加或更新的标签的键值对。如果您指定与现有标签相同的键,则系统会更新现有标签的值。键必须是唯一的。
  • project_id 为您的项目 ID
  • dataset 是包含您要更新的表或视图的数据集
  • table_or_view 是您要更新的表或视图的名称

示例:

要更新 mytabledepartment 标签,请输入 bq update 命令并将 department 指定为标签键。例如,要将 department:shipping 标签更新为 mytabledepartment:logistics,请输入以下命令。mytable 属于 myotherproject,而非默认项目。

    bq update \
    --set_label department:logistics \
    myotherproject:mydataset.mytable

输出如下所示:

Table 'myotherproject:mydataset.mytable' successfully updated.

API

要添加其他标签或更新现有表或试图的标签,请调用 tables.patch 方法,然后为表资源添加或更新 labels 属性。

由于视图被视为表资源,因此您可以使用 tables.patch 方法来修改视图和表。

由于 tables.update 方法会替换整个数据集资源,因此最好使用 tables.patch 方法。

Go

尝试此示例之前,请按照 BigQuery 快速入门:使用客户端库中的 Go 设置说明进行操作。如需了解详情,请参阅 BigQuery Go API 参考文档

import (
	"context"
	"fmt"

	"cloud.google.com/go/bigquery"
)

// addTableLabel demonstrates adding Label metadata to a BigQuery table.
func addTableLabel(projectID, datasetID, tableID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	// tableID := "mytable"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}

	tbl := client.Dataset(datasetID).Table(tableID)
	meta, err := tbl.Metadata(ctx)
	if err != nil {
		return err
	}

	update := bigquery.TableMetadataToUpdate{}
	update.SetLabel("color", "green")
	if _, err := tbl.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

Java

此示例使用 Java 版 Google HTTP 客户端库向 BigQuery API 发送请求。

尝试此示例之前,请按照《BigQuery 快速入门:使用客户端库》中的 Java 设置说明进行操作。如需了解详情,请参阅 BigQuery Java API 参考文档

public static class Table {
  @Key private Map<String, String> labels;

  public Map<String, String> getLabels() {
    return this.labels;
  }

  public Table addLabel(String key, String value) {
    if (this.labels == null) {
      this.labels = new HashMap<>();
    }
    this.labels.put(key, value);
    return this;
  }
}

/**
 * Add or modify a label on a table.
 *
 * <p>See <a href="https://cloud.google.com/bigquery/docs/labeling-datasets">the BigQuery
 * documentation</a>.
 */
public static void labelTable(
    String projectId,
    String datasetId,
    String tableId,
    String labelKey,
    String labelValue)
    throws IOException {

  // Authenticate requests using Google Application Default credentials.
  GoogleCredential credential = GoogleCredential.getApplicationDefault();
  credential = credential.createScoped(Arrays.asList("https://www.googleapis.com/auth/bigquery"));

  // Get a new access token.
  // Note that access tokens have an expiration. You can reuse a token rather than requesting a
  // new one if it is not yet expired.
  credential.refreshToken();
  String accessToken = credential.getAccessToken();

  // Set the content of the request.
  Table table = new Table();
  table.addLabel(labelKey, labelValue);
  HttpContent content = new JsonHttpContent(JSON_FACTORY, table);

  // Send the request to the BigQuery API.
  String urlFormat =
      "https://www.googleapis.com/bigquery/v2/projects/%s/datasets/%s/tables/%s"
          + "?fields=labels&access_token=%s";
  GenericUrl url =
      new GenericUrl(String.format(urlFormat, projectId, datasetId, tableId, accessToken));
  HttpRequestFactory requestFactory = HTTP_TRANSPORT.createRequestFactory();
  HttpRequest request = requestFactory.buildPostRequest(url, content);
  request.setParser(JSON_FACTORY.createJsonObjectParser());

  // Workaround for transports which do not support PATCH requests.
  // See: http://stackoverflow.com/a/32503192/101923
  request.setHeaders(new HttpHeaders().set("X-HTTP-Method-Override", "PATCH"));
  HttpResponse response = request.execute();

  // Check for errors.
  if (response.getStatusCode() != 200) {
    throw new RuntimeException(response.getStatusMessage());
  }

  Table responseTable = response.parseAs(Table.class);
  System.out.printf(
      "Updated label \"%s\" with value \"%s\"\n",
      labelKey, responseTable.getLabels().get(labelKey));
}

Node.js

尝试此示例之前,请按照 BigQuery 快速入门:使用客户端库中的 Node.js 设置说明进行操作。如需了解详情,请参阅 BigQuery Node.js API 参考文档

// Import the Google Cloud client library
const {BigQuery} = require('@google-cloud/bigquery');
const bigquery = new BigQuery();

async function labelTable() {
  // Adds a label to an existing table.

  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // const datasetId = 'my_dataset';
  // const tableId = 'my_table';

  const dataset = bigquery.dataset(datasetId);
  const [table] = await dataset.table(tableId).get();

  // Retrieve current table metadata
  const [metadata] = await table.getMetadata();

  // Add label to table metadata
  metadata.labels = {color: 'green'};
  const [apiResponse] = await table.setMetadata(metadata);

  console.log(`${tableId} labels:`);
  console.log(apiResponse.labels);
}

Python

尝试此示例之前,请按照《BigQuery 快速入门:使用客户端库》中的 Python 设置说明进行操作。如需了解详情,请参阅 BigQuery Python API 参考文档

# from google.cloud import bigquery
# client = bigquery.Client()
# table_ref = client.dataset('my_dataset').table('my_table')
# table = client.get_table(table_ref)  # API request

assert table.labels == {}
labels = {"color": "green"}
table.labels = labels

table = client.update_table(table, ["labels"])  # API request

assert table.labels == labels

更新作业标签

目前不支持更新作业标签。要更新作业标签,请使用指定的新标签重新提交作业。

将标签转换为标记

如果一个标签的键为空值,则此标签用作标记。您可以创建一个未设定值的新标签,也可以将现有标签转换为数据集、表或视图上的标记。作业标签无法转换为标记。

如果您要标记资源,但无需采用 key:value 格式,则可以使用标记。例如,如果您的表包含由多个群组(支持、开发等)使用的测试数据,则可为该表添加 test_data 标记作识别之用。

所需权限

要将标签转换为标记,必须至少具有更新标签所需的权限。

  • bigquery.datasets.update 用于转换数据集标签
  • bigquery.tables.update 用于转换表或视图标签

以下预定义的 Cloud IAM 角色可提供 bigquery.datasets.update 权限:

  • bigquery.dataOwner
  • bigquery.admin

以下预定义的 Cloud IAM 角色可提供 bigquery.tables.update 权限:

  • bigquery.dataEditor
  • bigquery.dataOwner
  • bigquery.admin

此外,如果用户具有 bigquery.datasets.create 权限,则当该用户创建数据集时,系统会为其授予该数据集的 bigquery.dataOwner 访问权限。借助 bigquery.dataOwner 访问权限,用户可更新数据集上的标签以及这些数据集中的表和视图。

如需详细了解 BigQuery 中的 Cloud IAM 角色和权限,请参阅预定义的角色和权限

将标签转换为标记

要将标签转换为标记,请执行以下操作:

控制台

  1. 在 Cloud Console 中,选择相应的数据集、表或视图。

  2. 对于数据集,系统会自动打开数据集详情页面。对于表和视图,请点击详细信息以打开详情页面。

    表详细信息

  3. 在详情页面上,点击标签右侧的铅笔图标。

    标签铅笔

  4. 修改标签对话框中执行以下操作:

    • 删除现有标签的值。
    • 点击更新

经典版界面

  1. 在网页界面,选择相应的数据集、表或视图。

  2. 对于数据集,系统会自动打开 Dataset Details 页面。对于表和视图,请点击 Details 以打开详情页面。

  3. 在详情页面,点击 Labels 右侧的 Edit。

  4. Edit Labels 对话框中:

    • 删除现有标签的值。
    • 点击 OK

      添加标记

CLI

要将标签转换为标记,请使用带 set_label 标志的 bq update 命令。指定键,再后接英文冒号,但不指定值。这会将现有标签更新为标记。

bq update \
--set_label key: \
resource_id

其中:

  • key 是要更新为标记的标签键
  • resource_id 是有效的数据集、表或视图名称。如果资源属于非默认项目,请按以下格式添加项目 ID:project_id:dataset

示例:

输入以下命令可将 mydataset 的现有 test_data:development 标签更新为标记。mydataset 属于 myotherproject,而非默认项目。

bq update --set_label test_data: myotherproject:mydataset

输出如下所示:

Dataset 'myotherproject:mydataset' successfully updated.

API

如需将现有标签转换为标记,请调用 datasets.patch 方法或 tables.patch 方法,并将数据集资源表资源中的标签值替换为空字符串 ("")。

由于视图被视为表资源,因此您可以使用 tables.patch 方法来修改视图和表。另外,由于 tables.update 方法会替换整个数据集资源,因此最好使用 tables.patch 方法。

后续步骤