라벨 업데이트

이 페이지에서는 BigQuery 리소스의 라벨을 업데이트하는 방법을 설명합니다.

데이터 세트 라벨 업데이트

데이터 세트 라벨을 다음 방법으로 업데이트할 수 있습니다.

  • Cloud Console 또는 기본 BigQuery 웹 UI 사용
  • bq 명령줄 도구의 bq update 명령어 사용
  • datasets.patch API 메서드 호출
  • 클라이언트 라이브러리 사용

필수 권한

데이터 세트 라벨을 업데이트하려면 최소한 bigquery.datasets.update 권한을 부여받아야 합니다. 다음과 같은 사전 정의된 IAM 역할에는 bigquery.datasets.update 권한이 포함되어 있습니다.

  • bigquery.dataOwner
  • bigquery.admin

또한 bigquery.datasets.create 권한이 있는 사용자는 데이터 세트를 만들 때 해당 데이터 세트에 대한 bigquery.dataOwner 액세스 권한을 부여받습니다. bigquery.dataOwner 액세스 권한이 있는 사용자는 데이터 세트의 라벨을 업데이트할 수 있습니다.

BigQuery의 IAM 역할 및 권한에 대한 자세한 내용은 사전 정의된 역할 및 권한을 참조하세요.

데이터 세트 라벨 업데이트

데이터 세트의 라벨을 업데이트하려면 다음 안내를 따르세요.

Console

  1. Cloud Console에서 데이터 세트를 선택합니다.

  2. 데이터 세트 세부정보 페이지에서 라벨 오른쪽에 있는 연필 아이콘을 클릭합니다.

    라벨 연필

  3. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 추가 라벨을 적용하려면 라벨 추가를 클릭합니다. 각 키는 데이터 세트당 한 번만 사용할 수 있지만 동일한 프로젝트의 여러 데이터 세트에 같은 키를 사용할 수 있습니다.
    • 기존 키 또는 값을 수정하여 라벨을 업데이트합니다.
    • 업데이트를 클릭하여 변경사항을 저장합니다.

기본 UI

  1. 웹 UI에서 데이터 세트를 선택합니다.

  2. 데이터 세트 세부정보 페이지에서 라벨 오른쪽의 수정을 클릭합니다.

    라벨 수정

  3. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 추가 라벨을 적용하려면 라벨 추가를 클릭합니다. 각 키는 데이터 세트당 한 번만 사용할 수 있지만 동일한 프로젝트의 여러 데이터 세트에 같은 키를 사용할 수 있습니다.
    • 기존 키 또는 값을 수정하여 라벨을 업데이트합니다.
    • 확인을 클릭합니다.

      새 라벨

bq

라벨을 추가하거나 데이터 세트 라벨을 업데이트하려면 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)
	}
	defer client.Close()

	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
}

자바

이 샘플은 자바용 Google HTTP 클라이언트 라이브러리를 사용하여 BigQuery API에 요청을 전송합니다.

이 샘플을 사용해 보기 전에 BigQuery 빠른 시작: 클라이언트 라이브러리 사용의 자바 설정 안내를 따르세요. 자세한 내용은 BigQuery 자바 API 참조 문서를 확인하세요.

import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Dataset;
import java.util.HashMap;
import java.util.Map;

// Sample to updates a label on dataset
public class LabelDataset {

  public static void runLabelDataset() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    labelDataset(datasetName);
  }

  public static void labelDataset(String datasetName) {
    try {
      // Initialize client that will be used to send requests. This client only needs to be created
      // once, and can be reused for multiple requests.
      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

      // This example dataset starts with existing label { color: 'green' }
      Dataset dataset = bigquery.getDataset(datasetName);
      // Add label to dataset
      Map<String, String> labels = new HashMap<>();
      labels.put("color", "green");

      dataset.toBuilder().setLabels(labels).build().update();
      System.out.println("Label added successfully");
    } catch (BigQueryException e) {
      System.out.println("Label was not added. \n" + e.toString());
    }
  }
}

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 참조 문서를 확인하세요.


from google.cloud import bigquery

# 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 웹 UI 사용
  • bq 명령줄 도구의 bq update 명령어 사용
  • tables.patch API 메서드 호출
    • 뷰는 테이블 리소스와 같이 취급되므로 tables.patch 메서드를 사용하여 뷰와 테이블을 모두 수정합니다.
  • 클라이언트 라이브러리 사용

필수 권한

테이블 또는 뷰 라벨을 업데이트하려면 최소한 bigquery.tables.update 권한을 부여받아야 합니다. 다음과 같은 사전 정의된 IAM 역할에는 bigquery.tables.update 권한이 포함되어 있습니다.

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

또한 bigquery.datasets.create 권한이 있는 사용자는 데이터 세트를 만들 때 해당 데이터 세트에 대한 bigquery.dataOwner 액세스 권한을 부여받습니다. bigquery.dataOwner 액세스 권한이 있는 사용자는 데이터 세트와 그 안에 있는 테이블과 뷰의 라벨을 업데이트할 수 있습니다.

BigQuery의 IAM 역할 및 권한에 대한 자세한 내용은 사전 정의된 역할 및 권한을 참조하세요.

테이블 또는 뷰 라벨 업데이트

테이블 또는 뷰 라벨을 업데이트하려면 다음 안내를 따르세요.

Console

  1. Cloud Console에서 테이블 또는 뷰를 선택합니다.

  2. 세부정보 탭을 클릭한 후 라벨 오른쪽에 있는 연필 아이콘을 클릭합니다.

  3. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 추가 라벨을 적용하려면 라벨 추가를 클릭합니다. 각 키는 테이블 또는 뷰당 한 번만 사용할 수 있지만 데이터 세트가 다른 테이블 또는 뷰에는 동일한 키를 사용할 수 있습니다.
    • 기존 키 또는 값을 수정하여 라벨을 업데이트합니다.
    • 업데이트를 클릭하여 변경사항을 저장합니다.

기본 UI

  1. 웹 UI에서 테이블 또는 뷰를 선택합니다.

  2. 세부정보 페이지에서 라벨 오른쪽의 수정을 클릭합니다. 이 예시에서는 테이블의 세부정보를 보여줍니다.

    라벨 수정

  3. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 추가 라벨을 추가하려면 라벨 추가를 클릭합니다. 각 키는 테이블 또는 뷰당 한 번만 사용할 수 있지만 데이터 세트가 다른 테이블 또는 뷰에는 동일한 키를 사용할 수 있습니다.
    • 기존 키 또는 값을 수정하여 라벨을 업데이트합니다.
    • 확인을 클릭합니다.

      새 라벨

bq

라벨을 추가하거나 테이블 또는 뷰 라벨을 업데이트하려면 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를 지정합니다. 예를 들어 mytable에서 department:shipping 라벨을 department: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)
	}
	defer client.Close()

	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
}

자바

이 샘플은 자바용 Google HTTP 클라이언트 라이브러리를 사용하여 BigQuery API에 요청을 전송합니다.

이 샘플을 사용해 보기 전에 BigQuery 빠른 시작: 클라이언트 라이브러리 사용의 자바 설정 안내를 따르세요. 자세한 내용은 BigQuery 자바 API 참조 문서를 확인하세요.

import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Table;
import com.google.cloud.bigquery.TableId;
import java.util.HashMap;
import java.util.Map;

// Sample to adds a label to an existing table
public class LabelTable {

  public static void runLabelTable() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String tableName = "MY_TABLE_NAME";
    labelTable(datasetName, tableName);
  }

  public static void labelTable(String datasetName, String tableName) {
    try {
      // Initialize client that will be used to send requests. This client only needs to be created
      // once, and can be reused for multiple requests.
      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

      // This example table starts with existing label { color: 'green' }
      Table table = bigquery.getTable(TableId.of(datasetName, tableName));
      // Add label to table
      Map<String, String> labels = new HashMap<>();
      labels.put("color", "green");

      table.toBuilder().setLabels(labels).build().update();
      System.out.println("Label added successfully");
    } catch (BigQueryException e) {
      System.out.println("Label was not added. \n" + e.toString());
    }
  }
}

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()
# project = client.project
# dataset_ref = bigquery.DatasetReference(project, dataset_id)
# table_ref = dataset_ref.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: 테이블 또는 뷰 라벨 변환

다음과 같은 사전 정의된 IAM 역할에는 bigquery.datasets.update 권한이 포함되어 있습니다.

  • bigquery.dataOwner
  • bigquery.admin

다음과 같은 사전 정의된 IAM 역할에는 bigquery.tables.update 권한이 포함되어 있습니다.

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

또한 bigquery.datasets.create 권한이 있는 사용자는 데이터 세트를 만들 때 해당 데이터 세트에 대한 bigquery.dataOwner 액세스 권한을 부여받습니다. bigquery.dataOwner 액세스 권한이 있는 사용자는 데이터 세트와 그 안에 있는 테이블과 뷰의 라벨을 업데이트할 수 있습니다.

BigQuery의 IAM 역할 및 권한에 대한 자세한 내용은 사전 정의된 역할 및 권한을 참조하세요.

라벨을 태그로 변환

라벨을 태그로 변환하려면 다음 안내를 따르세요.

Console

  1. Cloud Console에서 데이터 세트, 테이블 또는 뷰를 선택합니다.

  2. 데이터 세트의 경우 데이터 세트 세부정보 페이지가 자동으로 열립니다. 테이블 및 뷰의 경우 세부정보를 클릭하여 세부정보 페이지를 엽니다.

    테이블 세부정보

  3. 세부정보 페이지에서 라벨 오른쪽에 있는 연필 아이콘을 클릭합니다.

    라벨 연필

  4. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 기존 라벨 값을 삭제합니다.
    • 업데이트를 클릭합니다.

기본 UI

  1. 웹 UI에서 데이터 세트, 테이블 또는 뷰를 선택합니다.

  2. 데이터 세트의 경우 데이터 세트 세부정보 페이지가 자동으로 열립니다. 테이블 및 뷰의 경우 세부정보를 클릭하여 세부정보 페이지를 엽니다.

  3. 세부정보 페이지에서 라벨 오른쪽의 수정을 클릭합니다.

  4. 라벨 수정 대화상자에서 다음을 수행합니다.

    • 기존 라벨 값을 삭제합니다.
    • 확인을 클릭합니다.

      태그 추가

bq

라벨을 태그로 변환하려면 set_label 플래그가 지정된 bq update 명령어를 사용합니다. 키를 지정하고 그 뒤에 콜론을 입력하고, 값을 지정하지 않고 비워 둡니다. 기존 라벨이 태그로 업데이트됩니다.

bq update \
--set_label key: \
resource_id

각 항목의 의미는 다음과 같습니다.

  • key:는 태그로 업데이트할 라벨 키입니다.
  • resource_id는 유효한 데이터 세트, 테이블 또는 뷰 이름입니다. 리소스가 기본 프로젝트 이외의 프로젝트에 있으면 project_id:dataset 형식으로 프로젝트 ID를 추가합니다.

예:

다음 명령어를 입력하여 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 메서드를 사용하는 것이 좋습니다.

다음 단계