データセットの一覧表示

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

データセットは、次の方法で一覧表示できます。

  • GCP Console または従来の BigQuery ウェブ UI
  • bq ls CLI コマンド
  • datasets.list API メソッドの呼び出し

必要な権限

データセットを一覧表示するときは、自分が bigquery.datasets.get 権限を持つデータセットだけが返されます。これには、自分がデータセット レベルの READER アクセス権を持っているデータセットも含まれます。事前定義されたプロジェクト レベルの IAM 役割のうち、bigquery.jobUser 以外には、bigquery.datasets.get 権限が含まれています。事前定義されたプロジェクト レベルの IAM 役割(bigquery.jobUser 以外)が割り当てられているユーザーは、そのプロジェクト内のすべてのデータセットを一覧表示できます。

BigQuery での IAM 役割と権限の詳細については、アクセス制御をご覧ください。データセット レベルの役割の詳細については、データセットに対する基本の役割をご覧ください。

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

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

Console

ウェブ UI の [リソース] パネルには、プロジェクト別にデータセットが一覧表示にされます。

従来の UI

ウェブ UI のナビゲーション パネルには、プロジェクト別にデータセットが一覧表示にされます。

コマンドライン

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 形式で詳細な結果を返すように --formatprettyjson に設定されています。

bq ls --format=prettyjson --project_id myotherproject

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

bq ls -a

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

bq ls --max_results 60

次のコマンドを入力して、デフォルト プロジェクト内のデータセットをのうち org:dev というラベルが付いたものを一覧表示します。

ba ls --filter labels.org:dev

API

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

C#

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

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 のリファレンス ドキュメントをご覧ください。

// 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")
it := client.Datasets(ctx)
for {
	dataset, err := it.Next()
	if err == iterator.Done {
		break
	}
	fmt.Println(dataset.DatasetID)
}

Java

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

// List datasets in the default project
Page<Dataset> datasets = bigquery.listDatasets(DatasetListOption.pageSize(100));
for (Dataset dataset : datasets.iterateAll()) {
  // do something with the dataset
}
// List datasets in a specified project
Page<Dataset> datasets = bigquery.listDatasets(projectId, DatasetListOption.pageSize(100));
for (Dataset dataset : datasets.iterateAll()) {
  // do something with the dataset
}

Node.js

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

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

async function listDatasets() {
  // Lists all datasets in current GCP project.

  // Create a client
  const bigqueryClient = new BigQuery();

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

PHP

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

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 のリファレンス ドキュメントをご覧ください。

from google.cloud import bigquery

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

datasets = list(client.list_datasets())
project = client.project

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

Ruby

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

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

次のステップ

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

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

ご不明な点がありましたら、Google のサポートページをご覧ください。