ビューのプロパティの更新

このドキュメントでは、ビュープロパティとメタデータの更新方法について説明します。ビューを作成したら、次のビュープロパティを更新できます。

SQL クエリ
有効期限
説明
ラベル

必要な権限

ビューを更新するには、少なくとも bigquery.tables.update 権限と bigquery.tables.get 権限が付与されている必要があります。ビューの SQL クエリを更新する場合は、ビューの SQL クエリで参照されるテーブルに対してクエリを実行する権限も必要です。

次の定義済みの IAM ロールには bigquery.tables.update 権限と bigquery.tables.get 権限が含まれています。

bigquery.dataEditor
bigquery.dataOwner
bigquery.admin

また、bigquery.datasets.create 権限を持つユーザーがデータセットを作成すると、そのデータセットに対する bigquery.dataOwner アクセス権がユーザーに付与されます。bigquery.dataOwner アクセス権により、データセットに含まれるテーブルとビューに対する更新の実行権限が付与されます。

BigQuery での IAM のロールと権限について詳しくは、事前定義ロールと権限をご覧ください。

ビューの SQL クエリの更新

ビューの定義に使用される SQL クエリは、次の方法で更新できます。

Cloud Console の使用
bq コマンドラインツールの bq update コマンドを使用する
tables.patch API メソッドを呼び出す
クライアントライブラリを使用する

API または bq コマンドラインツールで、SQL 言語をレガシー SQL から標準 SQL に変更できます。Cloud Console では、レガシー SQL ビューを標準 SQL にアップデートすることはできません。

ビューの SQL クエリを更新するには:

Console

[リソース] パネルで、プロジェクトとデータセットを展開し、ビューを選択します。
[詳細] タブをクリックします。
[クエリ] ボックスの上の、[クエリを編集] ボタンをクリックします。表示されたダイアログの [開く] をクリックします。
[クエリエディタ] ボックスで SQL クエリを編集し、[ビューを保存] をクリックします。
[ビューを保存] ダイアログですべてのフィールドが正しいことを確認してから、[保存] をクリックします。

bq

--view フラグを指定して bq update コマンドを発行します。標準 SQL を使用して、クエリ言語をレガシー SQL から標準 SQL に更新するには、--use_legacy_sql フラグを指定し、false に設定します。

Cloud Storage またはローカルファイルに格納されている外部のユーザー定義関数リソースをクエリで参照する場合は、--view_udf_resource フラグを使用してリソースを指定します。--view_udf_resource フラグはここでは説明しません。UDF の使用方法の詳細については、標準 SQL ユーザー定義関数をご覧ください。

更新するビューがデフォルトプロジェクト以外のプロジェクトにある場合は、project_id:dataset の形式でプロジェクト ID をデータセット名に追加します。

bq update \
--use_legacy_sql=false \
--view_udf_resource=path_to_file \
--view='query' \
project_id:dataset.view

ここで

path_to_file は、ビューで使用されるユーザー定義関数リソースとして読み込まれ、すぐに評価されるコードファイルの URI またはローカルファイルシステムのパスです。複数のファイルを指定するには、フラグを繰り返します。
query は、有効な標準 SQL クエリです。
project_id はプロジェクト ID です。
dataset はビューを含むデータセットです。
view は、更新するビューの名前です。

例:

次のコマンドを入力して、mydataset の myview という名前のビューの SQL クエリを更新します。mydataset はデフォルトプロジェクトにあります。ビューを更新するために使用されるクエリの例では、USA Name Data パブリックデータセットのデータをクエリします。

bq update \
--use_legacy_sql=false \
--view \
'SELECT
  name,
  number
FROM
  `bigquery-public-data.usa_names.usa_1910_current`
WHERE
  gender = "M"
ORDER BY
  number DESC' \
mydataset.myview

次のコマンドを入力して、mydataset の myview という名前のビューの SQL クエリを更新します。mydataset はデフォルトプロジェクトではなく myotherproject にあります。ビューを更新するために使用されるクエリの例では、USA Name Data パブリックデータセットのデータをクエリします。

bq update \
--use_legacy_sql=false \
--view \
'SELECT
  name,
  number
FROM
  `bigquery-public-data.usa_names.usa_1910_current`
WHERE
  gender = "M"
ORDER BY
  number DESC' \
myotherproject:mydataset.myview

API

ビューを更新するには、更新された view プロパティを含むテーブルリソースを使用して tables.patch メソッドを呼び出します。tables.update メソッドはテーブルリソース全体を置き換えるため、tables.patch メソッドの方が適切です。

Go

このサンプルを試す前に、BigQuery クイックスタート: クライアントライブラリの使用の Go の手順に従って設定を行ってください。詳細については、BigQuery Go API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import (
	"context"
	"fmt"

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

// updateView demonstrates updating the query metadata that defines a logical view.
func updateView(projectID, datasetID, viewID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	// viewID := "myview"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}
	defer client.Close()

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

	newMeta := bigquery.TableMetadataToUpdate{
		// This example updates a view into the shakespeare dataset to exclude works named after kings.
		ViewQuery: "SELECT word, word_count, corpus, corpus_date FROM `bigquery-public-data.samples.shakespeare` WHERE corpus NOT LIKE '%king%'",
	}

	if _, err := view.Update(ctx, newMeta, meta.ETag); err != nil {
		return err
	}
	return nil
}

Java

このサンプルを試す前に、BigQuery クイックスタート: クライアントライブラリの使用の Java の設定手順を実施してください。詳細については、BigQuery Java API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.TableId;
import com.google.cloud.bigquery.TableInfo;
import com.google.cloud.bigquery.ViewDefinition;

// Sample to update query on a view
public class UpdateViewQuery {

  public static void runUpdateViewQuery() {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String tableName = "MY_TABLE_NAME";
    String viewName = "MY_VIEW_NAME";
    String updateQuery =
        String.format("SELECT TimestampField, StringField FROM %s.%s", datasetName, tableName);
    updateViewQuery(datasetName, viewName, updateQuery);
  }

  public static void updateViewQuery(String datasetName, String viewName, String query) {
    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();

      // Retrieve existing view metadata
      TableInfo viewMetadata = bigquery.getTable(TableId.of(datasetName, viewName));

      // Update view query
      ViewDefinition viewDefinition = viewMetadata.getDefinition();
      viewDefinition.toBuilder().setQuery(query).build();

      // Set metadata
      bigquery.update(viewMetadata.toBuilder().setDefinition(viewDefinition).build());

      System.out.println("View query updated successfully");
    } catch (BigQueryException e) {
      System.out.println("View query was not updated. \n" + e.toString());
    }
  }
}

Node.js

このサンプルを試す前に、BigQuery クイックスタート: クライアントライブラリの使用の Node.js の設定手順を実施してください。詳細については、BigQuery Node.js API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

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

async function updateViewQuery() {
  // Updates a view named "my_existing_view" in "my_dataset".

  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // const datasetId = "my_existing_dataset"
  // const tableId = "my_existing_table"
  const dataset = await bigquery.dataset(datasetId);

  // This example updates a view into the USA names dataset to include state.
  const newViewQuery = `SELECT name, state
  FROM \`bigquery-public-data.usa_names.usa_1910_current\`
  LIMIT 10`;

  // Retrieve existing view
  const [view] = await dataset.table(tableId).get();

  // Retrieve existing view metadata
  const [metadata] = await view.getMetadata();

  // Uodate view query
  metadata.view = newViewQuery;

  // Set metadata
  await view.setMetadata(metadata);

  console.log(`View ${tableId} updated.`);
}

Python

このサンプルを試す前に、BigQuery クイックスタート: クライアントライブラリの使用の Python の手順に従って設定を行ってください。詳細については、BigQuery Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

# from google.cloud import bigquery
# client = bigquery.Client()
# project = 'my-project'
# source_dataset_id = 'my_source_dataset'
# source_table_id = 'us_states'
# shared_dataset_ref = bigquery.DatasetReference(project, 'my_shared_dataset')

# This example shows how to update a shared view of a source table of
# US States. The view's query will be updated to contain only states with
# names starting with 'M'.
view_ref = shared_dataset_ref.table("my_shared_view")
view = bigquery.Table(view_ref)
sql_template = 'SELECT name, post_abbr FROM `{}.{}.{}` WHERE name LIKE "M%"'
view.view_query = sql_template.format(project, source_dataset_id, source_table_id)
view = client.update_table(view, ["view_query"])  # API request

ビューの有効期限の更新

デフォルトのテーブル有効期限をデータセットレベルで設定することも（テーブルとビューの両方に反映される）、ビューを作成するときにそのビューの有効期限を設定することもできます。ビューを作成するときに有効期限を設定すると、データセットのデフォルトのテーブル有効期限は無視されます。デフォルトのテーブル有効期限をデータセットレベルで設定せず、ビューの作成時にも有効期限を設定しなかった場合は、ビューが失効することはないので、ビューを手動で削除する必要があります。

ビューを作成した後、次の方法でビューの有効期限を更新できます。

bq コマンドラインツールの bq update コマンドを使用する
tables.patch API メソッドを呼び出す
クライアントライブラリを使用する

ビューの有効期限を更新するには:

Console

ナビゲーションパネルで、ビューを選択します。
[詳細を表示] ページで、[詳細] タブをクリックします。
[ビューの情報] の右側にある編集アイコン（鉛筆）をクリックします。
[ビューの情報] ダイアログの [有効期限の表示] で、[日付を指定] をクリックします。
日付ピッカーで有効期限の日付と時刻を入力し、[OK] をクリックします。
[更新] をクリックします。更新された有効期限が [ビュー情報] セクションに表示されます。

SQL

データ定義言語（DDL）ステートメントを使用すると、標準 SQL クエリ構文を使用してテーブルとビューの作成と変更ができます。

データ定義言語ステートメントの使用をご覧ください。

Cloud Console で DDL ステートメントを使用するには:

[クエリを新規作成] をクリックします。

[クエリエディタ] テキスト領域に DDL ステートメントを入力します。

ALTER VIEW mydataset.myview
SET OPTIONS (
-- Sets view expiration to timestamp 2025-02-03 12:34:56 in the America/Los Angeles time zone
expiration_timestamp=TIMESTAMP("2025-02-03 12:34:56", "America/Los Angeles")
);

[実行] をクリックします。

bq

--expiration フラグを指定して bq update コマンドを発行します。更新するビューがデフォルトプロジェクト以外のプロジェクトにある場合は、project_id:dataset の形式でプロジェクト ID をデータセット名に追加します。

bq update \
--expiration integer \
project_id:dataset.view

ここで

integer はテーブルのデフォルトの存続期間（秒）です。最小値は 3,600 秒（1 時間）です。現在時刻にこの整数値を足した値が有効期限になります。
project_id はプロジェクト ID です。
dataset は、更新するビューが存在しているデータセットの名前です。
view は更新するビューの名前です。

例:

次のコマンドを入力して、mydataset 内の myview のパーティションの有効期限を 5 日間（432,000 秒）に更新します。mydataset はデフォルトプロジェクトにあります。

bq update --expiration 432000 mydataset.myview

次のコマンドを入力して、mydataset 内の myview のパーティションの有効期限を 5 日間（432,000 秒）に更新します。mydataset はデフォルトプロジェクトではなく myotherproject にあります。

bq update --expiration 432000 myotherproject:mydataset.myview

API

tables.patch メソッドを呼び出し、テーブルリソースの expirationTime プロパティを使用します。tables.update メソッドはテーブルリソース全体を置き換えるため、tables.patch メソッドの方が適切です。REST API を使用する場合、ビューの有効期限はミリ秒単位で表されます。

Go

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"time"

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

// updateTableExpiration demonstrates setting the table expiration of a table to a specific point in time
// in the future, at which time it will be deleted.
func updateTableExpiration(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()

	tableRef := client.Dataset(datasetID).Table(tableID)
	meta, err := tableRef.Metadata(ctx)
	if err != nil {
		return err
	}
	update := bigquery.TableMetadataToUpdate{
		ExpirationTime: time.Now().Add(time.Duration(5*24) * time.Hour), // table expiration in 5 days.
	}
	if _, err = tableRef.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

Java

GitHub で表示フィードバック

Table beforeTable = bigquery.getTable(datasetName, tableName);

// Set table to expire 5 days from now.
long expirationMillis = DateTime.now().plusDays(5).getMillis();
TableInfo tableInfo = beforeTable.toBuilder()
        .setExpirationTime(expirationMillis)
        .build();
Table afterTable = bigquery.update(tableInfo);

Node.js

GitHub で表示フィードバック

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

async function updateTableExpiration() {
  // Updates a table's expiration.

  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // const datasetId = 'my_dataset', // Existing dataset
  // const tableId = 'my_table', // Existing table
  // const expirationTime = Date.now() + 1000 * 60 * 60 * 24 * 5 // 5 days from current time in ms

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

  // Set new table expiration to 5 days from current time
  metadata.expirationTime = expirationTime.toString();
  const [apiResponse] = await table.setMetadata(metadata);

  const newExpirationTime = apiResponse.expirationTime;
  console.log(`${tableId} expiration: ${newExpirationTime}`);
}

Python

ビューの有効期限の更新は、テーブルの有効期限の更新と同じプロセスです。

GitHub で表示フィードバック

import datetime
import pytz

# 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.expires is None

# set table to expire 5 days from now
expiration = datetime.datetime.now(pytz.utc) + datetime.timedelta(days=5)
table.expires = expiration
table = client.update_table(table, ["expires"])  # API request

# expiration is stored in milliseconds
margin = datetime.timedelta(microseconds=1000)
assert expiration - margin <= table.expires <= expiration + margin

ビューの説明の更新

ビューの説明は次の方法で更新できます。

Cloud Console の使用
bq コマンドラインツールの bq update コマンドを使用する
tables.patch API メソッドを呼び出す
クライアントライブラリを使用する

ビューの説明を更新するには:

Console

Cloud Console を使用してビューを作成する場合、説明を追加することはできません。ビューの作成後に、[詳細] ページで説明を追加できます。

[リソース] リストで、ビューを選択します。
[詳細] タブをクリックします。
[説明] の横にある鉛筆アイコンをクリックします。
ダイアログボックスに説明を入力します。[更新] をクリックして、新しい説明を保存します。

SQL

データ定義言語（DDL）ステートメントを使用すると、標準 SQL クエリ構文を使用してテーブルとビューの作成と変更ができます。

データ定義言語ステートメントの使用をご覧ください。

Cloud Console で DDL ステートメントを使用するには:

[クエリを新規作成] をクリックします。
[クエリエディタ] テキスト領域に DDL ステートメントを入力します。
```
 ALTER VIEW mydataset.myview
 SET OPTIONS (
   description="Description of myview"
 );
 
```
[実行] をクリックします。

bq

--description フラグを指定して bq update コマンドを発行します。更新するビューがデフォルトプロジェクト以外のプロジェクトにある場合は、[PROJECT_ID]:[DATASET] の形式でプロジェクト ID をデータセット名に追加します。

bq update \
--description "description" \
project_id:dataset.view

ここで

description は引用符で囲んだ、ビューを説明するテキストです。
project_id はプロジェクト ID です。
dataset は、更新するビューが存在しているデータセットの名前です。
view は更新するビューの名前です。

例:

次のコマンドを入力して、mydataset の myview の説明を「Description of myview」に変更します。mydataset はデフォルトプロジェクトにあります。

bq update --description "Description of myview" mydataset.myview

mydataset 内の myview の説明を「Description of myview」に変更するには、次のコマンドを入力します。mydataset はデフォルトプロジェクトではなく myotherproject にあります。

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

API

tables.patch メソッドを呼び出し、description プロパティを使用して、テーブルリソースのビューの説明を更新します。tables.update メソッドはテーブルリソース全体を置き換えるため、tables.patch メソッドの方が適切です。

Go

GitHub で表示フィードバック

import (
	"context"
	"fmt"

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

// updateTableDescription demonstrates how to fetch a table's metadata and updates the Description metadata.
func updateTableDescription(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()

	tableRef := client.Dataset(datasetID).Table(tableID)
	meta, err := tableRef.Metadata(ctx)
	if err != nil {
		return err
	}
	update := bigquery.TableMetadataToUpdate{
		Description: "Updated description.",
	}
	if _, err = tableRef.Update(ctx, update, meta.ETag); err != nil {
		return err
	}
	return nil
}

Java

ビューの説明の更新は、テーブルの説明の更新と同じプロセスです。

GitHub で表示フィードバック

// String datasetName = "my_dataset_name";
// String tableName = "my_table_name";
// String newDescription = "new_description";

Table beforeTable = bigquery.getTable(datasetName, tableName);
TableInfo tableInfo = beforeTable.toBuilder()
    .setDescription(newDescription)
    .build();
Table afterTable = bigquery.update(tableInfo);

Node.js

GitHub で表示フィードバック

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

async function updateTableDescription() {
  // Updates a table's description.

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

  // Set new table description
  const description = 'New table description.';
  metadata.description = description;
  const [apiResponse] = await table.setMetadata(metadata);
  const newDescription = apiResponse.description;

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

Python

ビューの説明の更新は、テーブルの説明の更新と同じプロセスです。

GitHub で表示フィードバック

# 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.description == "Original description."
table.description = "Updated description."

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

assert table.description == "Updated description."

次のステップ

ビューのコピーや削除など、ビューの管理の詳細については、ビューの管理をご覧ください。
ビューの作成方法については、ビューの作成をご覧ください。
承認済みビューの作成方法については、承認済みビューの作成をご覧ください。
ビューの一覧表示の詳細については、ビューの一覧表示をご覧ください。
ビューのメタデータを取得する方法については、ビューの情報の取得をご覧ください。