データセットの一覧表示

このドキュメントでは、BigQuery でデータセットを一覧表示する方法について説明します。

次の方法でデータセットを作成できます。

Cloud コンソールを使用する。
INFORMATION_SCHEMA SQL クエリを使用する。
bq コマンドラインツールで bq ls コマンドを使用する。
datasets.list API メソッドを呼び出す。
クライアントライブラリを使用する。

始める前に

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

必要な権限

データセットを一覧表示するには、bigquery.datasets.get IAM 権限が必要です。

次の IAM 事前定義ロールには、ビューの作成に必要な権限が含まれています。

roles/bigquery.user
roles/bigquery.dataOwner
roles/bigquery.dataEditor
roles/bigquery.admin

また、roles/bigquery.metadataViewer と roles/bigquery.dataViewer をプロジェクトレベルまたは組織レベルで適用した場合、プロジェクト内のすべてのデータセットを一覧表示できます。

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

プロジェクト内のデータセットの一覧表示

プロジェクト内のデータセットを一覧表示するには:

Console

ナビゲーションメニューで、[SQL ワークスペース] をクリックします。
[エクスプローラ] パネルでプロジェクト名を開き、そのプロジェクトのデータセットを表示するか、検索ボックスを使用してデータセット名で検索します。

SQL

INFORMATION_SCHEMA クエリでプロジェクト修飾子を使用して、プロジェクト内のすべてのデータセットを一覧表示します。

次の例では、指定したプロジェクトで使用可能なすべてのデータセットを一覧表示しています。

SELECT
 schema_name
FROM
'PROJECT_ID'.INFORMATION_SCHEMA.SCHEMATA

PROJECT_ID は、使用可能なデータセットを一覧表示するプロジェクトの ID に置き換えます。

INFORMATION_SCHEMA の詳細については、BigQuery INFORMATION_SCHEMA の概要をご覧ください。

bq

bq ls コマンドを発行すると、データセットのリストがデータセット ID 順に返されます。--format フラグを使用して出力を制御できます。デフォルトプロジェクト以外のプロジェクト内にあるデータセットを一覧表示するには、--project_id フラグをコマンドに追加します。

匿名のデータセットを含むプロジェクトのデータセットを一覧表示するには、--all フラグまたは -a ショートカットを使用します。

匿名データセットを除くプロジェクトのデータセットを一覧表示するには、--datasets フラグまたは -d ショートカットを使用します。このフラグは省略可能です。デフォルトでは、匿名データセットはリストに含まれません。

その他のフラグ:

--filter: フィルタ式に一致するデータセットを一覧表示します。labels.key:value という形式のラベルキーと値のスペース区切りリストを使用します。ラベルを使用したデータセットのフィルタリングの詳細については、ラベルの追加と使用をご覧ください。
--max_results または -n : 結果の最大数を示す整数。デフォルト値は 50 です。

bq ls --filter labels.key:value \
--max_results integer \
--format=prettyjson \
--project_id project_id

次のように置き換えます。

key:value はラベルのキーと値です。
integer は一覧表示するデータセットの数を表す整数です。
project_id はプロジェクトの名前です。

例:

デフォルトプロジェクト内のデータセットを一覧表示するには、次のコマンドを入力します。基本の整形されたテーブルを返すように -- format は pretty に設定されています。

bq ls --format=pretty

次のコマンドを入力して、myotherproject のデータセットを一覧表示します。詳細な結果を JSON 形式で返すように、--format は prettyjson に設定されています。

bq ls --format=prettyjson --project_id myotherproject

次のコマンドを入力して、デフォルトプロジェクト内の匿名データセットを含むすべてのデータセットを一覧表示します。出力では、匿名データセットの名前はアンダースコアで始まります。

bq ls -a

次のコマンドを入力して、デフォルトプロジェクトからデフォルト出力数の 50 を超えるデータセットを返します。

bq ls --max_results 60

次のコマンドを入力して、デフォルトプロジェクト内でラベル org:dev を持つデータセットを一覧表示します。

bq ls --filter labels.org:dev

API

API を使用してデータセットを一覧表示するには、datasets.list API メソッドを呼び出します。

C#

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

エディタで開く

GitHub で表示フィードバック


using Google.Cloud.BigQuery.V2;
using System;
using System.Collections.Generic;
using System.Linq;

public class BigQueryListDatasets
{
    public void ListDatasets(
        string projectId = "your-project-id"
    )
    {
        BigQueryClient client = BigQueryClient.Create(projectId);
        // Retrieve list of datasets in project
        List<BigQueryDataset> datasets = client.ListDatasets().ToList();
        // Display the results
        if (datasets.Count > 0)
        {
            Console.WriteLine($"Datasets in project {projectId}:");
            foreach (var dataset in datasets)
            {
                Console.WriteLine($"\t{dataset.Reference.DatasetId}");
            }
        }
        else
        {
            Console.WriteLine($"{projectId} does not contain any datasets.");
        }
    }
}

Go

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

エディタで開く

GitHub で表示フィードバック

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/bigquery"
	"google.golang.org/api/iterator"
)

// listDatasets demonstrates iterating through the collection of datasets in a project.
func listDatasets(projectID string, w io.Writer) error {
	// projectID := "my-project-id"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}
	defer client.Close()

	it := client.Datasets(ctx)
	for {
		dataset, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Fprintln(w, dataset.DatasetID)
	}
	return nil
}

Java

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

エディタで開く

GitHub で表示フィードバック

import com.google.api.gax.paging.Page;
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQuery.DatasetListOption;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Dataset;

public class ListDatasets {

  public static void runListDatasets() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "MY_PROJECT_ID";
    listDatasets(projectId);
  }

  public static void listDatasets(String projectId) {
    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();

      Page<Dataset> datasets = bigquery.listDatasets(projectId, DatasetListOption.pageSize(100));
      if (datasets == null) {
        System.out.println("Dataset does not contain any models");
        return;
      }
      datasets
          .iterateAll()
          .forEach(
              dataset -> System.out.printf("Success! Dataset ID: %s ", dataset.getDatasetId()));
    } catch (BigQueryException e) {
      System.out.println("Project does not contain any datasets \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 listDatasets() {
  // Lists all datasets in current GCP project.

  // Lists all datasets in the specified project
  const [datasets] = await bigquery.getDatasets();
  console.log('Datasets:');
  datasets.forEach(dataset => console.log(dataset.id));
}

PHP

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

エディタで開く

GitHub で表示フィードバック

use Google\Cloud\BigQuery\BigQueryClient;

/** Uncomment and populate these variables in your code */
// $projectId  = 'The Google project ID';

$bigQuery = new BigQueryClient([
    'projectId' => $projectId,
]);
$datasets = $bigQuery->datasets();
foreach ($datasets as $dataset) {
    print($dataset->id() . PHP_EOL);
}

Python

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

エディタで開く

GitHub で表示フィードバック


from google.cloud import bigquery

# Construct a BigQuery client object.
client = bigquery.Client()

datasets = list(client.list_datasets())  # Make an API request.
project = client.project

if datasets:
    print("Datasets in project {}:".format(project))
    for dataset in datasets:
        print("\t{}".format(dataset.dataset_id))
else:
    print("{} project does not contain any datasets.".format(project))

Ruby

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

エディタで開く

GitHub で表示フィードバック

require "google/cloud/bigquery"

def list_datasets project_id = "your-project-id"
  bigquery = Google::Cloud::Bigquery.new project: project_id

  puts "Datasets in project #{project_id}:"
  bigquery.datasets.each do |dataset|
    puts "\t#{dataset.dataset_id}"
  end
end

データセットのセキュリティ

BigQuery でデータセットへのアクセスを制御するには、データセットへのアクセスの制御をご覧ください。データ暗号化の詳細については、保存データの暗号化をご覧ください。

次のステップ

データセット作成の詳細については、データセットの作成をご覧ください。
データセットメタデータの詳細については、データセットに関する情報の取得をご覧ください。
データセットプロパティの変更方法について詳しくは、データセットの更新をご覧ください。
ラベルの作成と管理の詳細は、ラベルの作成と管理をご覧ください。