데이터 세트 속성 업데이트

이 문서에서는 BigQuery에서 데이터 세트 속성을 업데이트하는 방법을 설명합니다. 데이터 세트를 만든 후에는 다음과 같은 데이터 세트 속성을 업데이트할 수 있습니다.

필수 권한

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

  • bigquery.dataOwner
  • bigquery.admin

또한 bigquery.datasets.create 권한이 있는 사용자는 데이터 세트를 만들 때 데이터 세트에 대한 bigquery.dataOwner 액세스 권한을 부여받습니다. bigquery.dataOwner 액세스 권한이 있는 사용자는 자신이 만든 데이터 세트의 테이블 속성을 업데이트할 수 있습니다.

BigQuery의 IAM 역할과 권한에 대한 자세한 내용은 액세스 제어를 참조하세요.

데이터 세트 설명 업데이트

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

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

데이터 세트 설명을 업데이트하려면 다음 안내를 따르세요.

Console

  1. 리소스 창에서 데이터 세트를 선택합니다.

  2. 세부정보 페이지의 설명 옆에 있는 연필 아이콘을 클릭하여 설명 텍스트를 수정합니다.

    쿼리 설정

  3. 대화상자의 상자에 설명을 입력하거나 기존 설명을 수정합니다. 업데이트를 클릭하여 새 설명 텍스트를 저장합니다.

기본 UI

  1. 탐색창에서 데이터 세트를 선택합니다.

  2. 데이터 세트에 설명이 없으면 Dataset Details(데이터 세트 세부정보) 페이지의 Description(설명) 섹션에서 Describe this dataset(이 데이터 세트 설명)를 클릭하여 설명 상자를 엽니다. 그렇지 않으면 기존 설명 텍스트를 클릭합니다.

  3. 상자에 설명을 입력하거나 기존 설명을 편집합니다. 상자 바깥을 클릭하면 텍스트가 저장됩니다.

    데이터 세트 설명

bq

bq update 명령어를 --description 플래그와 함께 실행합니다. 기본 프로젝트가 아닌 다른 프로젝트의 데이터 세트를 업데이트하려면 해당 프로젝트 ID를 project_id:dataset 형식으로 데이터 세트 이름에 추가합니다.

bq update \
--description "string" \
project_id:dataset

다음을 바꿉니다.

  • string: 따옴표로 묶인 데이터 세트를 설명하는 텍스트
  • project_id: 프로젝트 ID
  • dataset: 업데이트할 데이터 세트의 이름

예를 들면 다음과 같습니다.

다음 명령어를 입력하면 mydataset를 'Description of mydataset'로 변경할 수 있습니다. 여기서 mydataset는 기본 프로젝트에 있습니다.

bq update --description "Description of mydataset" mydataset

다음 명령어를 입력하면 mydataset를 'Description of mydataset'로 변경할 수 있습니다. 데이터 세트는 기본 프로젝트가 아닌 myotherproject에 있습니다.

bq update \
--description "Description of mydataset" \
myotherproject:mydataset

API

datasets.patch를 호출하고 데이터 세트 리소스description 속성을 업데이트합니다. datasets.update 메서드는 전체 데이터 세트 리소스를 대체하므로 datasets.patch 메서드를 사용하는 것이 좋습니다.

Go

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

import (
	"context"
	"fmt"

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

// updateDatasetDescription demonstrates how the Description metadata of a dataset can
// be read and modified.
func updateDatasetDescription(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{
		Description: "Updated Description.",
	}
	if _, err = ds.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

자바

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

Dataset.toBuilder() 메서드를 사용하여 기존 Dataset 인스턴스에서 Dataset.Builder 인스턴스를 만듭니다. 데이터 세트 빌더 객체를 구성합니다. Dataset.Builder.build() 메서드를 사용하여 업데이트된 데이터 세트를 빌드하고 Dataset.update() 메서드를 호출하여 업데이트를 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;

public class UpdateDatasetDescription {

  public static void runUpdateDatasetDescription() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String newDescription = "this is the new dataset description";
    updateDatasetDescription(datasetName, newDescription);
  }

  public static void updateDatasetDescription(String datasetName, String newDescription) {
    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();

      Dataset dataset = bigquery.getDataset(datasetName);
      bigquery.update(dataset.toBuilder().setDescription(newDescription).build());
      System.out.println("Dataset description updated successfully to " + newDescription);
    } catch (BigQueryException e) {
      System.out.println("Dataset description was not updated \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 updateDatasetDescription() {
  // Updates a dataset's description.

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

  // Set new dataset description
  const description = 'New dataset description.';
  metadata.description = description;

  const [apiResponse] = await dataset.setMetadata(metadata);
  const newDescription = apiResponse.description;

  console.log(`${datasetId} description: ${newDescription}`);
}

Python

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

Dataset.description 속성을 구성하고 Client.update_dataset()를 호출하여 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.description = "Updated description."
dataset = client.update_dataset(dataset, ["description"])  # Make an API request.

full_dataset_id = "{}.{}".format(dataset.project, dataset.dataset_id)
print(
    "Updated dataset '{}' with description '{}'.".format(
        full_dataset_id, dataset.description
    )
)

기본 테이블 만료 시간 업데이트

다음 방법으로 데이터 세트의 기본 테이블 만료 시간을 업데이트할 수 있습니다.

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

데이터 세트 수준에서 기본 테이블 만료 시간을 설정하거나 테이블을 만들 때 테이블 만료 시간을 설정할 수 있습니다. 테이블을 만들 때 만료를 설정할 경우, 데이터 세트의 기본 테이블 만료가 무시됩니다. 데이터 세트 수준에서 기본 테이블 만료를 설정하지 않고, 테이블을 만들 때 테이블 만료를 설정하지 않으면 테이블이 만료되지 않으며, 테이블을 수동으로 삭제해야 합니다.

데이터 세트의 기본 테이블 만료 설정을 업데이트할 때는 다음을 참조하세요.

  • 값을 Never에서 정의된 만료 시간으로 변경할 경우 테이블 생성 시 만료 시간을 테이블에 설정하지 않았으면 데이터 세트에 이미 있는 테이블은 만료되지 않습니다.
  • 기본 테이블 만료 값을 변경할 경우, 기존의 모든 테이블이 원래 테이블 만료 설정에 따라 만료됩니다. 테이블을 만들 때 테이블에 다른 테이블 만료를 지정하지 않는 한 데이터 세트에서 생성되는 모든 새로운 테이블에 새로운 테이블 만료 설정이 적용됩니다.

기본 테이블 만료 값은 값이 설정된 위치에 따라 다르게 표시됩니다. 원하는 세부 수준에 따라 적절한 방법을 사용합니다.

  • Cloud Console과 기본 BigQuery 웹 UI에서는 만료 시간이 일 단위로 표시됩니다.
  • bq 명령줄 도구에서는 만료 시간이 초 단위로 표시됩니다.
  • API에서는 만료 시간이 밀리초 단위로 표시됩니다.

데이터 세트의 기본 만료 시간을 업데이트하려면 다음 안내를 따르세요.

Console

  1. 리소스 창에서 데이터 세트를 선택합니다.

  2. 세부정보 페이지에서 데이터 세트 정보 옆에 있는 연필 아이콘을 클릭하여 만료 시간을 수정합니다.

  3. 데이터 세트 정보 대화상자의 기본 테이블 만료 섹션에서 테이블 생성 후 경과 일수에 값을 입력합니다.

  4. 저장을 클릭합니다.

기본 UI

  1. 탐색창에서 데이터 세트를 선택합니다.

  2. 데이터 세트 세부정보 페이지의 세부정보 섹션에서 기본 테이블 만료 시간 오른쪽에 있는 수정을 클릭합니다.

    테이블 만료 시간

  3. Update Expiration(만료 업데이트) 대화상자에서 Data expiration(데이터 만료 시간)에 대해 In(남은 시간)을 클릭하고 만료 시간을 일 단위로 입력합니다. 기본값은 만료 안함입니다.

bq

데이터 세트에서 새로 생성되는 테이블의 기본 만료 시간을 업데이트하려면 --default_table_expiration 플래그를 사용하여 bq update 명령어를 입력합니다. 기본 프로젝트가 아닌 다른 프로젝트의 데이터 세트를 업데이트하려면 해당 프로젝트 ID를 project_id:dataset 형식으로 데이터 세트 이름에 추가합니다.

bq update \
--default_table_expiration integer \
project_id:dataset

다음을 바꿉니다.

  • integer: 새로 생성된 테이블의 기본 수명(초)입니다. 최솟값은 3,600초(1시간)입니다. 만료 시간은 현재 UTC 시간과 정수 값을 더한 값으로 계산됩니다. 기존 만료 시간을 삭제하려면 0을 지정합니다. 데이터 세트에서 생성된 모든 테이블은 생성 시간으로부터 integer초 후에 삭제됩니다. 테이블이 생성될 때 테이블 만료 시간을 설정하지 않은 경우 이 값이 적용됩니다.
  • project_id: 프로젝트 ID입니다.
  • dataset: 업데이트할 데이터 세트의 이름

예를 들면 다음과 같습니다.

다음 명령어를 입력하면 mydataset에서 생성되는 새 테이블의 기본 테이블 만료 시간을 현재 시간에서 2시간(7,200초) 이내로 설정할 수 있습니다. 데이터 세트는 기본 프로젝트에 있습니다.

bq update --default_table_expiration 7200 mydataset

다음 명령어를 입력하면 mydataset에서 생성되는 새 테이블의 기본 테이블 만료 시간을 현재 시간에서 2시간(7,200초) 이내로 설정할 수 있습니다. 데이터 세트는 기본 프로젝트가 아닌 myotherproject에 있습니다.

bq update --default_table_expiration 7200 myotherproject:mydataset

API

datasets.patch를 호출하고 데이터 세트 리소스defaultTableExpirationMs 속성을 업데이트합니다. API의 만료 시간은 밀리초 단위로 표시됩니다. datasets.update 메서드는 전체 데이터 세트 리소스를 대체하므로 datasets.patch 메서드를 사용하는 것이 좋습니다.

Go

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

import (
	"context"
	"fmt"
	"time"

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

// updateDatasetDefaultExpiration demonstrats setting the default expiration of a dataset
// to a specific retention period.
func updateDatasetDefaultExpiration(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{
		DefaultTableExpiration: 24 * time.Hour,
	}
	if _, err := client.Dataset(datasetID).Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

자바

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

Dataset.toBuilder() 메서드를 사용하여 기존 Dataset 인스턴스에서 Dataset.Builder 인스턴스를 만듭니다. 데이터 세트 빌더 객체를 구성합니다. Dataset.Builder.build() 메서드를 사용하여 업데이트된 데이터 세트를 빌드하고 Dataset.update() 메서드를 호출하여 업데이트를 API로 보냅니다.

Dataset.Builder.setDefaultTableLifetime() 메서드를 사용하여 기본 만료 시간을 구성합니다.

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.concurrent.TimeUnit;

public class UpdateDatasetExpiration {

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

  public static void updateDatasetExpiration(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();

      // Update dataset expiration to one day
      Long newExpiration = TimeUnit.MILLISECONDS.convert(1, TimeUnit.DAYS);

      Dataset dataset = bigquery.getDataset(datasetName);
      bigquery.update(dataset.toBuilder().setDefaultTableLifetime(newExpiration).build());
      System.out.println("Dataset description updated successfully to " + newExpiration);
    } catch (BigQueryException e) {
      System.out.println("Dataset expiration was not updated \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 updateDatasetExpiration() {
  // Updates the lifetime of all tables in the dataset, in milliseconds.

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

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

  // Set new dataset metadata
  const expirationTime = 24 * 60 * 60 * 1000;
  metadata.defaultTableExpirationMs = expirationTime.toString();

  const [apiResponse] = await dataset.setMetadata(metadata);
  const newExpirationTime = apiResponse.defaultTableExpirationMs;

  console.log(`${datasetId} expiration: ${newExpirationTime}`);
}

Python

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

Dataset.default_table_expiration_ms 속성을 구성하고 Client.update_dataset()를 호출하여 업데이트를 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.default_table_expiration_ms = 24 * 60 * 60 * 1000  # In milliseconds.

dataset = client.update_dataset(
    dataset, ["default_table_expiration_ms"]
)  # Make an API request.

full_dataset_id = "{}.{}".format(dataset.project, dataset.dataset_id)
print(
    "Updated dataset {} with new expiration {}".format(
        full_dataset_id, dataset.default_table_expiration_ms
    )
)

기본 파티션 만료 시간 업데이트

다음 방법으로 데이터 세트의 기본 파티션 만료 시간을 업데이트할 수 있습니다.

  • bq 명령줄 도구의 bq update 명령어 사용
  • datasets.patch API 메서드 호출
  • 클라이언트 라이브러리 사용

현재 Cloud Console이나 기본 BigQuery 웹 UI에서는 데이터 세트의 기본 파티션 만료 시간 설정 또는 업데이트가 지원되지 않습니다.

새로 생성된 파티션을 나눈 모든 테이블에 영향을 미치는 데이터 세트 수준에서 기본 파티션 만료 시간을 설정하거나 파티션을 나눈 테이블을 만들 때 개별 테이블의 파티션 만료 시간을 설정할 수 있습니다. 데이터 세트 수준에서 기본 파티션 만료 시간을 설정하고 데이터 세트 수준에서 기본 테이블 만료 시간을 설정하면 새로운 파티션을 나눈 테이블에는 파티션 만료 시간만 있습니다. 두 옵션을 모두 설정하면 기본 파티션 만료 시간이 기본 테이블 만료 시간을 재정의합니다.

파티션을 나눈 테이블을 만들 때 파티션 만료 시간을 설정하면 이 값은 데이터 세트 수준 기본 파티션 만료 시간이 존재하는 경우 이를 재정의합니다.

데이터 세트 수준에서 기본 파티션 만료를 설정하지 않고, 테이블을 만들 때 파티션 만료를 설정하지 않으면 파티션이 만료되지 않으며 파티션을 수동으로 삭제해야 합니다.

데이터 세트에서 기본 파티션 만료를 설정하면 이 만료가 데이터 세트에서 생성된 모든 파티션을 나눈 테이블의 모든 파티션에 적용됩니다. 테이블에 파티션 만료 시간을 설정하면 지정된 테이블에서 생성된 모든 파티션에 만료 시간이 적용됩니다. 현재는 같은 테이블에 있는 파티션마다 서로 다른 만료 시간을 적용할 수 없습니다.

데이터 세트의 기본 파티션 만료 시간 설정을 업데이트할 때는 다음에 유의하세요.

  • 값을 '만료되지 않음'에서 정의된 만료 시간으로 변경할 경우 테이블 생성 시 파티션 만료 시간을 테이블에 설정하지 않았으면 데이터 세트의 파티션을 나눈 테이블에 이미 있는 파티션은 만료되지 않습니다.
  • 기본 파티션 만료 시간 값을 변경하면 기존의 파티션을 나눈 테이블에 있는 모든 파티션이 원래의 기본 파티션 만료 시간에 따라 만료됩니다. 테이블 생성 시 다른 파티션 만료 시간을 테이블에 지정하지 않았으면 데이터 세트에서 생성되는 모든 새로운 파티션을 나눈 테이블에 새로운 기본 파티션 만료 시간 설정이 적용됩니다.

기본 파티션 만료 시간 값은 값이 설정된 위치에 따라 다르게 표시됩니다. 원하는 세부 수준에 따라 적절한 방법을 사용합니다.

  • bq 명령줄 도구에서는 만료 시간이 초 단위로 표시됩니다.
  • API에서는 만료 시간이 밀리초 단위로 표시됩니다.

데이터 세트의 기본 파티션 만료 시간을 업데이트하려면 다음 안내를 따르세요.

Console

현재 Cloud Console에서는 데이터 세트의 기본 파티션 만료 시간 업데이트가 지원되지 않습니다.

기본 UI

현재 BigQuery 웹 UI에서는 데이터 세트의 기본 파티션 만료 시간 업데이트가 지원되지 않습니다.

bq

데이터 세트의 기본 만료 시간을 업데이트하려면 --default_partition_expiration 플래그를 사용하여 bq update 명령어를 입력합니다. 기본 프로젝트가 아닌 다른 프로젝트의 데이터 세트를 업데이트하려면 해당 프로젝트 ID를 project_id:dataset 형식으로 데이터 세트 이름에 추가합니다.

bq update \
--default_partition_expiration integer \
project_id:dataset

다음을 바꿉니다.

  • integer: 새로 생성된 파티션을 나눈 테이블의 파티션 기본 수명(초)입니다. 이 플래그에는 최솟값이 없습니다. 기존 만료 시간을 삭제하려면 0을 지정합니다. 파티션의 UTC 날짜로부터 integer초가 지나면 새로 생성된 파티션을 나눈 테이블의 모든 파티션이 삭제됩니다. 테이블이 생성될 때 테이블에 파티션 만료 시간을 설정하지 않으면 이 값이 적용됩니다.
  • project_id: 프로젝트 ID
  • dataset: 업데이트할 데이터 세트의 이름

예를 들면 다음과 같습니다.

다음 명령어를 입력하면 mydataset에서 생성된 새로운 파티션을 나눈 테이블의 기본 파티션 만료 시간을 26시간(93,600초)으로 설정할 수 있습니다. 데이터 세트는 기본 프로젝트에 있습니다.

bq update --default_partition_expiration 93600 mydataset

다음 명령어를 입력하면 mydataset에서 생성된 새로운 파티션을 나눈 테이블의 기본 파티션 만료 시간을 26시간(93,600초)으로 설정할 수 있습니다. 데이터 세트는 기본 프로젝트가 아닌 myotherproject에 있습니다.

bq update --default_partition_expiration 93600 myotherproject:mydataset

API

datasets.patch를 호출하고 데이터 세트 리소스defaultPartitionExpirationMs 속성을 업데이트합니다. 만료 시간은 밀리초 단위로 표시됩니다. datasets.update 메서드는 전체 데이터 세트 리소스를 대체하므로 datasets.patch 메서드를 사용하는 것이 좋습니다.

데이터 세트 액세스 제어 업데이트

데이터 세트의 액세스 제어를 업데이트하는 과정은 데이터 세트에 액세스 제어를 할당하는 과정과 매우 비슷합니다. Cloud Console, 기본 BigQuery 웹 UI, bq 명령줄 도구에서 데이터 세트를 만드는 동안에는 액세스 제어를 적용할 수 없습니다. 먼저 데이터 세트를 만든 후 데이터 세트의 액세스 제어를 업데이트해야 합니다. API를 사용하면 datasets.patch 메서드를 호출하여 데이터 세트 액세스 제어를 업데이트할 수 있습니다.

데이터 세트에서 액세스 제어를 업데이트할 때는 다음 항목에 대한 액세스 권한을 수정할 수 있습니다.

  • Google 계정 이메일: 개별 Google 계정에 데이터 세트에 대한 액세스 권한을 부여합니다.
  • Google 그룹: Google 그룹의 모든 구성원에게 데이터 세트에 대한 액세스 권한을 부여합니다.
  • Google 앱 도메인: Google 도메인의 모든 사용자와 그룹에 데이터 세트 액세스 권한을 부여합니다.
  • 서비스 계정: 서비스 계정에 데이터 세트에 대한 액세스 권한을 부여합니다.
  • 모든 사람: 일반 대중에게 액세스 권한을 부여하려면 'allUsers'를 입력합니다.
  • 모든 Google 계정: Google 계정에 로그인한 모든 사용자에게 액세스 권한을 부여하려면 'allAuthenticatedUsers'를 입력합니다.
  • 승인된 보기: 승인된 보기에 데이터 세트에 대한 액세스 권한을 부여합니다.

데이터 세트에서 액세스 제어를 업데이트하려면 다음 안내를 따르세요.

Console

  1. 탐색창의 리소스 섹션에서 데이터 세트를 클릭합니다.

  2. 데이터 세트 공유를 클릭합니다.

  3. 데이터 세트 공유 대화상자에서 기존 항목을 삭제하려면 항목을 펼친 후 삭제 아이콘(휴지통)을 클릭합니다.

  4. 데이터 세트 공유 대화상자에서 새 항목을 추가하려면 다음 안내를 따르세요.

    1. 구성원 추가 상자에 항목을 입력합니다.

    2. 역할 선택 목록에서 적절한 IAM 역할을 선택합니다. 사전 정의된 각 BigQuery 역할에 할당된 권한에 대한 자세한 내용은 사전 정의된 역할 및 권한 페이지를 참조하세요.

    3. 추가를 클릭합니다.

  5. 승인된 보기를 추가하려면 Authorized View(승인된 보기) 탭을 클릭하고 프로젝트, 데이터 세트, 보기를 입력한 후 추가를 클릭합니다.

  6. 액세스 제어 권한을 추가 또는 삭제했으면 완료를 클릭합니다.

기본 UI

  1. 데이터 세트 오른쪽에 있는 드롭다운 화살표를 클릭하고 데이터 세트 공유를 선택합니다.

  2. 데이터 세트 공유 대화상자에서 기존 항목을 수정합니다.

    • 항목 오른쪽에 있는 X 아이콘을 클릭하여 기존 항목을 삭제합니다.
    • 권한 버튼을 클릭하고 적절한 액세스 수준(Is owner(OWNER), Can edit(WRITER) 또는 Can view(READER))을 선택하여 항목의 권한을 변경합니다. 데이터 세트 수준 역할에 대한 자세한 내용은 기본 역할 및 권한을 참조하세요.
  3. 데이터 세트 공유 대화상자에서 새 항목을 추가하려면 다음 안내를 따르세요.

    1. Add People(사용자 추가) 필드의 왼쪽에 있는 드롭다운을 클릭하고 적절한 옵션을 선택합니다.

    2. 텍스트 상자에 값을 입력합니다. 예를 들어 이메일별 사용자를 선택한 경우 사용자의 이메일 주소를 입력합니다.

    3. 사용자 추가 필드 오른쪽에서 보기 가능을 클릭하고 목록에서 적절한 역할을 선택합니다.

      데이터 세트에 사용자 추가

      • '보기 가능'(READER)은 bigquery.dataViewer에게 데이터 세트 액세스 권한을 부여합니다.
      • '수정 가능'(WRITER)은 bigquery.dataEditor에게 데이터 세트 액세스 권한을 부여합니다.
      • '소유자임'(OWNER)은 bigquery.dataOwner에게 데이터 세트 액세스 권한을 부여합니다.
    4. 추가를 클릭합니다.

  4. 액세스 제어 추가, 삭제 또는 수정이 완료되었으면 변경사항 저장을 클릭합니다.

  5. 데이터 세트 오른쪽에 있는 드롭다운 화살표를 클릭하고 데이터 세트 공유를 선택하여 액세스 제어를 확인합니다. 데이터 세트 공유 대화상자에서 설정을 확인할 수 있습니다.

bq

  1. show 명령어를 사용하여 JSON 파일에 기존 데이터 세트 정보(액세스 제어 포함)를 씁니다. 데이터 세트가 기본 프로젝트가 아닌 다른 프로젝트에 있다면 프로젝트 ID를 project_id:dataset 형식으로 데이터 세트 이름에 추가합니다.

    bq show \
    --format=prettyjson \
    project_id:dataset > path_to_file
    

    다음을 바꿉니다.

    • project_id: 프로젝트 ID
    • dataset: 데이터 세트의 이름
    • path_to_file: 로컬 머신의 JSON 파일 경로

    예를 들면 다음과 같습니다.

    다음 명령어를 입력하여 mydataset에 대한 액세스 제어를 JSON 파일에 씁니다. 여기서 mydataset는 사용자의 기본 프로젝트에 있습니다.

    bq show --format=prettyjson mydataset > /tmp/mydataset.json
    

    다음 명령어를 입력하여 mydataset에 대한 액세스 제어를 JSON 파일에 씁니다. mydatasetmyotherproject에 있습니다.

    bq show --format=prettyjson \
    myotherproject:mydataset > /tmp/mydataset.json
    
  2. JSON 파일의 "access" 섹션을 변경합니다. specialGroup 항목(projectOwners, projectWriters, projectReaders, allAuthenticatedUsers)을 추가하거나 삭제할 수 있습니다. userByEmail, groupByEmail, domain 항목도 추가, 삭제 또는 수정할 수 있습니다.

    예를 들어 데이터 세트 JSON 파일의 액세스 섹션은 다음과 비슷합니다.

    {
     "access": [
      {
       "role": "READER",
       "specialGroup": "projectReaders"
      },
      {
       "role": "WRITER",
       "specialGroup": "projectWriters"
      },
      {
       "role": "OWNER",
       "specialGroup": "projectOwners"
      }
      {
       "role": "READER",
       "specialGroup": "allAuthenticatedUsers"
      }
      {
       "role": "READER",
       "domain": "[DOMAIN_NAME]"
      }
      {
       "role": "WRITER",
       "userByEmail": "[USER_EMAIL]"
      }
      {
       "role": "READER",
       "groupByEmail": "[GROUP_EMAIL]"
      }
     ],
    }
    

  3. 수정이 완료되면 update 명령어를 사용하고 --source 플래그로 JSON 파일을 포함합니다. 데이터 세트가 기본 프로젝트가 아닌 다른 프로젝트에 있다면 프로젝트 ID를 project_id:dataset 형식으로 데이터 세트 이름에 추가합니다.

    bq update --source path_to_file project_id:dataset
    

    다음을 바꿉니다.

    • path_to_file: 로컬 머신의 JSON 파일 경로
    • project_id: 프로젝트 ID
    • dataset: 데이터 세트의 이름

    예를 들면 다음과 같습니다.

    다음 명령어를 입력하여 mydataset에 대한 액세스 제어를 업데이트합니다. 여기서 mydataset는 기본 프로젝트에 있습니다.

    bq update --source /tmp/mydataset.json mydataset
    

    다음 명령어를 입력하여 mydataset에 대한 액세스 제어를 업데이트합니다. mydatasetmyotherproject에 있습니다.

    bq update --source /tmp/mydataset.json myotherproject:mydataset
    
  4. 액세스 제어 변경사항을 확인하려면 파일에 정보를 쓰지 않고 show 명령어를 다시 입력합니다.

    bq show --format=prettyjson dataset
    

    또는

    bq show --format=prettyjson project_id:dataset
    

API

datasets.patch를 호출하고 데이터 세트 리소스access 속성을 업데이트합니다.

datasets.update 메서드는 전체 데이터 세트 리소스를 바꾸기 때문에 datasets.patch를 사용하여 액세스 제어를 업데이트하는 것이 좋습니다.

Go

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

import (
	"context"
	"fmt"

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

// updateDatasetAccessControl demonstrates how the access control policy of a dataset
// can be amended by adding an additional entry corresponding to a specific user identity.
func updateDatasetAccessControl(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
	}
	// Append a new access control entry to the existing access list.
	update := bigquery.DatasetMetadataToUpdate{
		Access: append(meta.Access, &bigquery.AccessEntry{
			Role:       bigquery.ReaderRole,
			EntityType: bigquery.UserEmailEntity,
			Entity:     "sample.bigquery.dev@gmail.com"},
		),
	}

	// Leverage the ETag for the update to assert there's been no modifications to the
	// dataset since the metadata was originally read.
	if _, err := ds.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

자바

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

Dataset.toBuilder() 메서드를 사용하여 기존 Dataset 인스턴스에서 Dataset.Builder 인스턴스를 만듭니다. 데이터 세트 빌더 객체를 구성합니다. Dataset.Builder.build() 메서드를 사용하여 업데이트된 데이터 세트를 빌드하고 Dataset.update() 메서드를 호출하여 업데이트를 API로 보냅니다.

Dataset.Builder.setAcl() 메서드로 액세스 제어를 구성합니다.

import com.google.cloud.bigquery.Acl;
import com.google.cloud.bigquery.Acl.Role;
import com.google.cloud.bigquery.Acl.User;
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.ArrayList;

public class UpdateDatasetAccess {

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

  public static void updateDatasetAccess(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();

      Dataset dataset = bigquery.getDataset(datasetName);

      // Create a new ACL granting the READER role to "sample.bigquery.dev@gmail.com"
      // For more information on the types of ACLs available see:
      // https://cloud.google.com/storage/docs/access-control/lists
      Acl newEntry = Acl.of(new User("sample.bigquery.dev@gmail.com"), Role.READER);

      // Get a copy of the ACLs list from the dataset and append the new entry
      ArrayList<Acl> acls = new ArrayList<>(dataset.getAcl());
      acls.add(newEntry);

      bigquery.update(dataset.toBuilder().setAcl(acls).build());
      System.out.println("Dataset Access Control updated successfully");
    } catch (BigQueryException e) {
      System.out.println("Dataset Access control was not updated \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 updateDatasetAccess() {
  // Updates a datasets's access controls.

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

  // Create new role metadata
  const newRole = {
    role: 'READER',
    entity_type: 'userByEmail',
    userByEmail: 'sample.bigquery.dev@gmail.com',
  };

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

  // Add new role to role acess array
  metadata.access.push(newRole);
  const [apiResponse] = await dataset.setMetadata(metadata);
  const newAccessRoles = apiResponse.access;
  newAccessRoles.forEach(role => console.log(role));
}

Python

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

데이터 세트에 대한 액세스 제어를 사용하여 dataset.access_entries 속성을 설정합니다. 그런 다음 client.update_dataset() 함수를 호출하여 속성을 업데이트합니다.
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.

entry = bigquery.AccessEntry(
    role="READER",
    entity_type="userByEmail",
    entity_id="sample.bigquery.dev@gmail.com",
)

entries = list(dataset.access_entries)
entries.append(entry)
dataset.access_entries = entries

dataset = client.update_dataset(dataset, ["access_entries"])  # Make an API request.

full_dataset_id = "{}.{}".format(dataset.project, dataset.dataset_id)
print(
    "Updated dataset '{}' with modified user permissions.".format(full_dataset_id)
)

다음 단계