データセットに関する情報の取得

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

データセット情報は次の方法で取得できます。

GCP Console または従来の BigQuery ウェブ UI
bq show CLI コマンド
datasets.get API メソッドの呼び出し
INFORMATION_SCHEMA ビューのクエリ（ベータ版）
クライアントライブラリを使用する

必要な権限

データセットに関する情報またはメタデータを取得するには、少なくとも bigquery.datasets.get 権限が付与されている必要があります。bigquery.datasets.get 権限は、次の事前定義された Cloud IAM 役割に含まれています。

bigquery.user
bigquery.metadataViewer
bigquery.dataViewer
bigquery.dataOwner
bigquery.dataEditor
bigquery.admin

BigQuery での Cloud IAM 役割と権限については、アクセス制御をご覧ください。

データセットの情報の取得

プロジェクト内のデータセットに関する情報を取得するには:

Console

[リソース] パネルでデータセット名をクリックします。[クエリエディタ] の下に、データセットの説明と詳細が表示されます。データセットのテーブルは、[リソース] パネル内のデータセット名の下に入れ子になっています。

データセットを表示

デフォルトでは、匿名データセットは BigQuery ウェブ UI に表示されません。匿名データセットの情報を表示するには、CLI または API を使用します。

従来の UI

データセット名をクリックします。[Dataset Details] ページに、データセットの説明、詳細、テーブルが表示されます。

データセットを表示

デフォルトでは、匿名データセットは BigQuery ウェブ UI に表示されません。匿名データセットの情報を表示するには、CLI または API を使用します。

CLI

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

匿名データセットの情報を表示するには、bq ls --all コマンドを使用してデータセットを一覧表示し、そこに示されている匿名データセットの名前を bq show コマンドで使用します。

bq show --format=prettyjson project_id:dataset

ここで

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

例:

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

bq show --format=prettyjson mydataset

myotherproject 内の mydataset に関する情報を表示するには、次のコマンドを入力します。

bq show --format=prettyjson myotherproject:mydataset

次のコマンドを入力して、匿名データセット（デフォルトプロジェクトでは _1234abcd56efgh78ijkl1234）の情報を表示します。

bq show --format=prettyjson _1234abcd56efgh78ijkl1234

API

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

Go

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

GitHub で表示フィードバック

// To run this sample, you will need to create (or reuse) a context and
// an instance of the bigquery client.  For example:
// import "cloud.google.com/go/bigquery"
// ctx := context.Background()
// client, err := bigquery.NewClient(ctx, "your-project-id")
meta, err := client.Dataset(datasetID).Metadata(ctx)
if err != nil {
	return err
}

fmt.Printf("Dataset ID: %s\n", datasetID)
fmt.Printf("Description: %s\n", meta.Description)
fmt.Println("Labels:")
for k, v := range meta.Labels {
	fmt.Printf("\t%s: %s", k, v)
}
fmt.Println("Tables:")
it := client.Dataset(datasetID).Tables(ctx)

cnt := 0
for {
	t, err := it.Next()
	if err == iterator.Done {
		break
	}
	cnt++
	fmt.Printf("\t%s\n", t.TableID)
}
if cnt == 0 {
	fmt.Println("\tThis dataset does not contain any tables.")
}

Java

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

GitHub で表示フィードバック

DatasetId datasetId = DatasetId.of(projectId, datasetName);
Dataset dataset = bigquery.getDataset(datasetId);

Python

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

GitHub で表示フィードバック

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)

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

# View dataset properties
print("Description: {}".format(dataset.description))
print("Labels:")
labels = dataset.labels
if labels:
    for label, value in labels.items():
        print("\t{}: {}".format(label, value))
else:
    print("\tDataset has no labels defined.")

# View tables in dataset
print("Tables:")
tables = list(client.list_tables(dataset))  # API request(s)
if tables:
    for table in tables:
        print("\t{}".format(table.table_id))
else:
    print("\tThis dataset does not contain any tables.")

`INFORMATION_SCHEMA`（ベータ版）

INFORMATION_SCHEMA は、データセット、テーブル、ビューに関するメタデータへのアクセスを提供する一連のビューです。

`SCHEMATA` ビュー

INFORMATION_SCHEMA.SCHEMATA ビューにクエリを実行すると、現在のユーザーがアクセスできるプロジェクトの各データセットが 1 行で返されます。

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

列名	データ型	値
`CATALOG_NAME`	`STRING`	データセットを含むプロジェクトの名前
`SCHEMA_NAME`	`STRING`	データセットの名前（`datasetId` と呼ぶこともある）
`SCHEMA_OWNER`	`STRING`	値は常に `NULL`
`CREATION_TIME`	`TIMESTAMP`	データセットの作成日時
`LAST_MODIFIED_TIME`	`TIMESTAMP`	データセットの最終更新日時
`LOCATION`	`STRING`	データセットの地理的なロケーション

データセットプロパティの詳細については、REST API ドキュメントのデータセットリソースのページをご覧ください。

例

次の例では、将来の使用に備えて予約されている schema_owner 列を除き、すべての列を INFORMATION_SCHEMA.SCHEMATA ビューから取得します。デフォルトプロジェクト（myproject）内のすべてのデータセットのメタデータが返されます。

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

クエリを実行するには:

Console

GCP Console で BigQuery ウェブ UI を開きます。

GCP Console に移動する
[クエリエディタ] ボックスに、次の標準 SQL クエリを入力します。 INFORMATION_SCHEMA では標準 SQL 構文が必要です。標準 SQL は GCP Console のデフォルトの構文です。
```
SELECT
 * EXCEPT(schema_owner)
FROM
 INFORMATION_SCHEMA.SCHEMATA
```
注: INFORMATION_SCHEMA ビューの名前では大文字と小文字が区別されます。
[実行] をクリックします。

CLI

query コマンドで、--nouse_legacy_sql または --use_legacy_sql=false フラグを使用して標準 SQL 構文を指定します。INFORMATION_SCHEMA クエリには標準 SQL 構文が必要です。

クエリを実行するには、次のように入力します。

bq query --nouse_legacy_sql \
'SELECT
   * EXCEPT(schema_owner)
 FROM
   INFORMATION_SCHEMA.SCHEMATA'

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

  +----------------+---------------+---------------------+---------------------+-----------------+
  |  catalog_name  |  schema_name  |    creation_time    | last_modified_time  |    location     |
  +----------------+---------------+---------------------+---------------------+-----------------+
  | myproject      | mydataset1    | 2018-11-07 19:50:24 | 2018-11-07 19:50:24 | US              |
  | myproject      | mydataset2    | 2018-07-16 04:24:22 | 2018-07-16 04:24:22 | US              |
  | myproject      | mydataset3    | 2018-02-07 21:08:45 | 2018-05-01 23:32:53 | asia-northeast1 |
  +----------------+---------------+---------------------+---------------------+-----------------+

`SCHEMATA_OPTIONS` ビュー

INFORMATION_SCHEMA.SCHEMATA_OPTIONS ビューにクエリを実行すると、現在のユーザーがアクセスできるプロジェクトの各データセットが 1 行で返されます。

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

列名	データ型	値
`CATALOG_NAME`	`STRING`	データセットを含むプロジェクトの名前
`SCHEMA_NAME`	`STRING`	データセットの名前（`datasetId` と呼ぶこともある）
`OPTION_NAME`	`STRING`	オプションテーブル内の名前の値の 1 つ
`OPTION_TYPE`	`STRING`	オプションテーブル内のデータ型の値の 1 つ
`OPTION_VALUE`	`STRING`	オプションテーブル内の値のオプションの 1 つ

オプションテーブル

`OPTION_NAME`	`OPTION_TYPE`	`OPTION_VALUE`
`default_table_expiration_days`	`FLOAT64`	データセット内のすべてのテーブルのデフォルトの有効期間（日数）
`friendly_name`	`STRING`	わかりやすいデータセット名
`description`	`STRING`	データセットの説明
`labels`	`ARRAY<STRUCT<STRING, STRING>>`	データセットのラベルを表す `STRUCT` の配列

データセットプロパティの詳細については、REST API ドキュメントのデータセットリソースのページをご覧ください。

例

例 1:

次の例では、INFORMATION_SCHEMATA.SCHEMATA_OPTIONS ビューにクエリを実行して、デフォルトプロジェクト（myproject）内のすべてのデータセットのデフォルトのテーブル有効期限を取得します。

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

クエリを実行するには:

Console

GCP Console で BigQuery ウェブ UI を開きます。

GCP Console に移動する
[クエリエディタ] ボックスに、次の標準 SQL クエリを入力します。 INFORMATION_SCHEMA では標準 SQL 構文が必要です。標準 SQL は GCP Console のデフォルトの構文です。
```
SELECT
 *
FROM
 INFORMATION_SCHEMA.SCHEMATA_OPTIONS
WHERE
 option_name="default_table_expiration_days"
```
注: INFORMATION_SCHEMA ビューの名前では大文字と小文字が区別されます。
[実行] をクリックします。

CLI

クエリを実行するには、次のように入力します。

bq query --nouse_legacy_sql \
'SELECT
   *
 FROM
   INFORMATION_SCHEMA.SCHEMATA_OPTIONS
 WHERE
   option_name="default_table_expiration_days"'

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

  +----------------+---------------+-------------------------------+-------------+---------------------+
  |  catalog_name  |  schema_name  |          option_name          | option_type |    option_value     |
  +----------------+---------------+-------------------------------+-------------+---------------------+
  | myproject      | mydataset3    | default_table_expiration_days | FLOAT64     | 0.08333333333333333 |
  | myproject      | mydataset2    | default_table_expiration_days | FLOAT64     | 90.0                |
  | myproject      | mydataset1    | default_table_expiration_days | FLOAT64     | 30.0                |
  +----------------+---------------+-------------------------------+-------------+---------------------+

例 2:

次の例では、INFORMATION_SCHEMATA.SCHEMATA_OPTIONS ビューにクエリを実行して、デフォルトプロジェクト（myproject）のすべてのデータセットのラベルを取得します。

クエリを実行するには:

Console

GCP Console で BigQuery ウェブ UI を開きます。

GCP Console に移動する
[クエリエディタ] ボックスに、次の標準 SQL クエリを入力します。 INFORMATION_SCHEMA では標準 SQL 構文が必要です。標準 SQL は GCP Console のデフォルトの構文です。
```
SELECT
 *
FROM
 INFORMATION_SCHEMA.SCHEMATA_OPTIONS
WHERE
 option_name="labels"
```
注: INFORMATION_SCHEMA ビューの名前では大文字と小文字が区別されます。
[実行] をクリックします。

CLI

クエリを実行するには、次のように入力します。

bq query --nouse_legacy_sql \
'SELECT
   *
 FROM
   INFORMATION_SCHEMA.SCHEMATA_OPTIONS
 WHERE
   option_name="labels"'

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

  +----------------+---------------+-------------+---------------------------------+------------------------+
  |  catalog_name  |  schema_name  | option_name |          option_type            |      option_value      |
  +----------------+---------------+-------------+---------------------------------+------------------------+
  | myproject      | mydataset1    | labels      | ARRAY<STRUCT<STRING, STRING>>   | [STRUCT("org", "dev")] |
  | myproject      | mydataset2    | labels      | ARRAY<STRUCT<STRING, STRING>>   | [STRUCT("org", "dev")] |
  +----------------+---------------+-------------+---------------------------------+------------------------+

次のステップ

データセットの作成方法について詳しくは、データセットの作成をご覧ください。
データセットにアクセス制御を割り当てる方法について詳しくは、データセットへのアクセス制御をご覧ください。
プロジェクト内のデータセットを一覧表示する方法について詳しくは、データセットの一覧表示をご覧ください。
データセットプロパティの変更方法について詳しくは、データセットの更新をご覧ください。
ラベルの作成と管理について詳しくは、ラベルの作成と管理をご覧ください。
INFORMATION_SCHEMA の概要については、BigQuery INFORMATION_SCHEMA の概要をご覧ください。

このページは役立ちましたか？評価をお願いいたします。

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

最終更新日: 9月 9, 2019

データセットに関する情報の取得

必要な権限

データセットの情報の取得

Console

従来の UI

CLI

API

Go

Java

Python

INFORMATION_SCHEMA（ベータ版）

SCHEMATA ビュー

例

Console

CLI

SCHEMATA_OPTIONS ビュー

オプション テーブル

例

例 1:

Console

CLI

例 2:

Console

CLI

次のステップ

フィードバックを送信...

`INFORMATION_SCHEMA`（ベータ版）

`SCHEMATA` ビュー

`SCHEMATA_OPTIONS` ビュー

オプションテーブル