データセットの一覧表示

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

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

GCP Console または従来の BigQuery ウェブ UI
bq ls CLI コマンド
datasets.list API メソッドを呼び出す
クライアントライブラリを使用する

必要な権限

データセットを一覧表示するときは、自分が bigquery.datasets.get 権限を持つデータセットだけが返されます。bigquery.datasets.get 権限は、次の事前定義された Cloud IAM 役割に含まれています。

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

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

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

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

Console

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

従来の UI

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

CLI

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 というラベルが付いたものを一覧表示します。

ba ls --filter labels.org:dev

API

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

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 で表示フィードバック

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

GitHub で表示フィードバック

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

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

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

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

次のステップ

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

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

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月 30, 2019

データセットの一覧表示

必要な権限

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

Console

従来の UI

CLI

API

C#

Go

Java

Node.js

PHP

Python

Ruby

次のステップ

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