ビューに関する情報の取得

このドキュメントでは、BigQuery ビューの情報やメタデータを取得する方法について説明します。

ビューのメタデータは、次の方法で取得できます。

Cloud Console の使用
bq コマンドラインツールの bq show コマンドを使用する
tables.get API メソッドを呼び出す
クライアントライブラリを使用する
INFORMATION_SCHEMA ビューのクエリを実行する（ベータ版）

始める前に

このドキュメントの各タスクを実行するために必要な権限をユーザーに与える Identity and Access Management（IAM）のロールを付与します。

必要な権限

ビューの情報を取得するには、bigquery.tables.get の IAM 権限が必要です。

次の各事前定義 IAM ロールには、それぞれビューに関する情報の取得に必要な権限が含まれています。

roles/bigquery.metadataViewer
roles/bigquery.dataViewer
roles/bigquery.dataOwner
roles/bigquery.dataEditor
roles/bigquery.admin

また、bigquery.datasets.create 権限がある場合は、自分が作成したデータセット内のビューに関する情報を取得できます。

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

ビューに関する情報の取得

ビューに関する情報を取得するプロセスは、テーブルに関する情報を取得するプロセスと同じです。

ビューに関する情報を取得するには:

Console

データセットを展開します。
ビュー名をクリックします。
[詳細] をクリックします。[詳細] タブには、ビューの説明、ビューの情報、ビューを定義する SQL クエリが表示されます。

bq

bq show コマンドを発行します。--format フラグを使用すると、出力を制御できます。デフォルト以外のプロジェクトにあるビューの情報を取得する場合は、[PROJECT_ID]:[DATASET] の形式でプロジェクト ID をデータセットに追加します。

bq show \
--format=prettyjson \
project_id:dataset.view

ここで

project_id はプロジェクト ID です。
dataset は、データセットの名前です。
view は、ビューの名前です。

例:

デフォルトプロジェクトのデータセット mydataset にある myview の情報を表示するには、次のコマンドを入力します。

bq show --format=prettyjson mydataset.myview

myotherproject のデータセット mydataset にある myview の情報を表示するには、次のコマンドを入力します。

bq show --format=prettyjson myotherproject:mydataset.myview

API

tables.get メソッドを呼び出し、関連パラメータを指定します。

Go

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

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"io"

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

// getView demonstrates fetching the metadata from a BigQuery logical view and printing it to an io.Writer.
func getView(w io.Writer, 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
	}
	fmt.Fprintf(w, "View %s, query: %s\n", view.FullyQualifiedName(), meta.ViewQuery)
	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.Table;
import com.google.cloud.bigquery.TableId;

// Sample to get a view
public class GetView {

  public static void main(String[] args) {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String viewName = "MY_VIEW_NAME";
    getView(datasetName, viewName);
  }

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

      TableId tableId = TableId.of(datasetName, viewName);
      Table view = bigquery.getTable(tableId);
      System.out.println("View retrieved successfully" + view.getDescription());
    } catch (BigQueryException e) {
      System.out.println("View not retrieved. \n" + e.toString());
    }
  }
}

Node.js

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

GitHub で表示フィードバック

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

async function getView() {
  // Retrieves view properties.

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

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

  const fullTableId = view.metadata.id;
  const viewQuery = view.metadata.view.query;

  // Display view properties
  console.log(`View at ${fullTableId}`);
  console.log(`View query: ${viewQuery}`);
}
getView();

Python

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

GitHub で表示フィードバック

from google.cloud import bigquery

client = bigquery.Client()

view_id = "my-project.my_dataset.my_view"
# Make an API request to get the table resource.
view = client.get_table(view_id)

# Display view properties
print(f"Retrieved {view.table_type}: {str(view.reference)}")
print(f"View Query:\n{view.view_query}")

`INFORMATION_SCHEMA`（ベータ版）

INFORMATION_SCHEMA は、データセット、ルーティン、テーブル、ビュー、ジョブ、予約、ストリーミングデータに関するメタデータへのアクセスを可能にする一連のビューです。

`VIEWS` ビュー

INFORMATION_SCHEMA.VIEWS ビューにクエリを実行すると、データセット内の各ビューに関する情報が 1 行ずつ表示されるクエリ結果が返されます。

INFORMATION_SCHEMA.VIEWS ビューのスキーマは次のとおりです。

列名	データ型	値
`TABLE_CATALOG`	`STRING`	データセットを含むプロジェクトの名前
`TABLE_SCHEMA`	`STRING`	ビューを含むデータセットの名前（データセット `id` ともいいます）
`TABLE_NAME`	`STRING`	ビューの名前（テーブル `id` ともいいます）
`VIEW_DEFINITION`	`STRING`	ビューを定義する SQL クエリ
`CHECK_OPTION`	`STRING`	常に `NULL` が返されます。
`USE_STANDARD_SQL`	`STRING`	標準 SQL クエリでビューが作成された場合は `YES`、`useLegacySql` が `true` に設定されている場合は `NO` が返されます。

例

例 1:

次の例では、今後の使用のために予約されている check_option を除き、すべての列を INFORMATION_SCHEMA.VIEWS ビューから取得します。デフォルトプロジェクト（myproject）にある mydataset 内のすべてのビューに対するメタデータが返されます。

デフォルトプロジェクト以外のプロジェクトに対してクエリを実行するには、この形式 `project_id`.dataset.INFORMATION_SCHEMA.view でそのプロジェクト ID をデータセットに追加します。例: `myproject`.mydataset.INFORMATION_SCHEMA.VIEWS

SELECT
  * EXCEPT (check_option)
FROM
  mydataset.INFORMATION_SCHEMA.VIEWS;

次のような結果になります。

  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+
  | table_catalog  | table_schema  |  table_name   |                        view_definition                              | use_standard_sql |
  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+
  | myproject      | mydataset     | myview        | SELECT column1, column2 FROM [myproject:mydataset.mytable] LIMIT 10 | NO               |
  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+

結果から、このビューはレガシー SQL クエリを使用して作成されたことがわかります。

例 2:

次の例では、デフォルトプロジェクト（myproject）で mydataset の myview の定義に使用する SQL クエリとクエリ構文を取得します。

SELECT
  table_name, view_definition, use_standard_sql
FROM
  mydataset.INFORMATION_SCHEMA.VIEWS
WHERE
  table_name = 'myview';

次のような結果になります。

  +---------------+---------------------------------------------------------------+------------------+
  |  table_name   |                        view_definition                        | use_standard_sql |
  +---------------+---------------------------------------------------------------+------------------+
  | myview        | SELECT column1, column2, column3 FROM mydataset.mytable       | YES              |
  +---------------+---------------------------------------------------------------+------------------+

結果から、このビューは標準の SQL クエリで作成されたことがわかります。

ビューのセキュリティ

BigQuery でビューへのアクセスを制御するには、ビューへのアクセスの制御をご覧ください。

次のステップ

ビューの作成方法については、ビューの作成をご覧ください。
承認済みビューの作成方法については、承認済みビューの作成をご覧ください。
ビューの一覧表示の詳細については、ビューの一覧表示をご覧ください。
ビューの更新の詳細については、ビューの更新をご覧ください。
ビューの管理の詳細については、ビューの管理をご覧ください。
INFORMATION_SCHEMA の概要については、BigQuery INFORMATION_SCHEMA の概要をご覧ください。

ビューに関する情報の取得

始める前に

必要な権限

ビューに関する情報の取得

Console

bq

API

Go

Java

Node.js

Python

INFORMATION_SCHEMA（ベータ版）

VIEWS ビュー

例

例 1:

例 2:

ビューのセキュリティ

次のステップ

`INFORMATION_SCHEMA`（ベータ版）

`VIEWS` ビュー