データセットの一覧表示
このドキュメントでは、BigQuery でデータセットに関する情報を一覧表示および取得する方法について説明します。
始める前に
このドキュメントの各タスクを実行するために必要な権限をユーザーに与える Identity and Access Management(IAM)のロールを付与します。
必要なロール
データセットの一覧表示、またはデータセットに関する情報の取得に必要な権限を取得するには、プロジェクトに対する BigQuery メタデータ閲覧者(roles/bigquery.metadataViewer
)IAM ロールを付与するように管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。
この事前定義ロールには、データセットの一覧表示や、データセットに関する情報の取得に必要な bigquery.datasets.get
権限が含まれています。
カスタムロールや他の事前定義ロールを使用して、この権限を取得することもできます。
プロジェクト レベルまたは組織レベルで roles/bigquery.metadataViewer
ロールを適用すると、プロジェクト内のすべてのデータセットを一覧表示できます。データセット レベルで roles/bigquery.metadataViewer
ロールを適用すると、そのロールが付与されているすべてのデータセットを一覧表示できます。
データセットのリスト表示
次のオプションのいずれかを選択します。
コンソール
ナビゲーション メニューで [BigQuery Studio] をクリックします。
[エクスプローラ] パネルでプロジェクト名を開き、そのプロジェクトのデータセットを表示するか、検索ボックスを使用してデータセット名で検索します。
SQL
INFORMATION_SCHEMA.SCHEMATA
ビューをクエリします。
Google Cloud コンソールで [BigQuery] ページに移動します。
クエリエディタで次のステートメントを入力します。
SELECT schema_name FROM PROJECT_ID.`region-REGION`.INFORMATION_SCHEMA.SCHEMATA;
次のように置き換えます。
PROJECT_ID
: Google Cloud プロジェクトの ID。指定しない場合は、デフォルトのプロジェクトが使用されます。REGION
: 任意のデータセット リージョン名。例:us
[
実行] をクリックします。
クエリの実行方法については、インタラクティブ クエリを実行するをご覧ください。
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 のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Go
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Go の設定手順を完了してください。詳細については、BigQuery Go API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Java
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Java の設定手順を完了してください。詳細については、BigQuery Java API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Node.js の設定手順を完了してください。詳細については、BigQuery Node.js API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
PHP
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある PHP の設定手順を完了してください。詳細については、BigQuery PHP API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Python
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Python の設定手順を完了してください。詳細については、BigQuery Python API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Ruby
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Ruby の設定手順を完了してください。詳細については、BigQuery Ruby API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
データセットに関する情報の取得
次のオプションのいずれかを選択します。
コンソール
[エクスプローラ] パネルでプロジェクトを展開し、データセットを選択します。
アクション オプションを開いて、[開く] をクリックします。[詳細] パネルに説明と詳細が表示されます。データセットのテーブルは、[エクスプローラ] パネルにデータセット名とともに表示されます。
デフォルトでは、非表示のデータセットは Google Cloud コンソールに表示されません。非表示のデータセットに関する情報を表示するには、bq コマンドライン ツールまたは API を使用します。
SQL
INFORMATION_SCHEMA.SCHEMATA
ビューをクエリします。
Google Cloud コンソールで [BigQuery] ページに移動します。
クエリエディタで次のステートメントを入力します。
SELECT * EXCEPT (schema_owner) FROM PROJECT_ID.`region-REGION`.INFORMATION_SCHEMA.SCHEMATA;
次のように置き換えます。
-
PROJECT_ID
: Google Cloud プロジェクトの ID。指定しない場合は、デフォルトのプロジェクトが使用されます。 -
REGION
: 任意のデータセット リージョン名。例:us
-
[
実行] をクリックします。
クエリの実行方法については、インタラクティブ クエリを実行するをご覧ください。
INFORMATION_SCHEMA.SCHEMATA_OPTIONS
ビューをクエリすることもできます。
SELECT * FROM PROJECT_ID.`region-REGION`.INFORMATION_SCHEMA.SCHEMATA_OPTIONS;
bq
bq show
コマンドを発行します。--format
フラグを使用して出力を制御できます。デフォルト以外のプロジェクトにあるデータセットの情報を取得する場合は、project_id:dataset
の形式でプロジェクト ID をデータセットに追加します。出力には、アクセス制御、ラベル、ロケーションなどのデータセットの情報が表示されます。このコマンドは、データセットの継承された権限は表示しませんが、Google Cloud コンソールで確認できます。
非表示のデータセットの情報を表示するには、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 のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Java
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Java の設定手順を完了してください。詳細については、BigQuery Java API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Node.js
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Node.js の設定手順を完了してください。詳細については、BigQuery Node.js API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Python
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Python の設定手順を完了してください。詳細については、BigQuery Python API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
データセット名を確認する
次のサンプルは、データセットが存在するかどうかを確認する方法を示しています。
Java
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Java の設定手順を完了してください。詳細については、BigQuery Java API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
Python
このサンプルを試す前に、クライアント ライブラリを使用した BigQuery クイックスタートにある Python の設定手順を完了してください。詳細については、BigQuery Python API のリファレンス ドキュメントをご覧ください。
BigQuery に対する認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、クライアント ライブラリの認証情報を設定するをご覧ください。
次のステップ
- データセット作成の詳細については、データセットの作成をご覧ください。
- データセットにアクセス制御を割り当てる方法について詳しくは、データセットへのアクセス制御をご覧ください。
- データセット プロパティの変更方法について詳しくは、データセット プロパティの更新をご覧ください。
- ラベルの作成と管理の詳細は、ラベルの作成と管理をご覧ください。
INFORMATION_SCHEMA
の概要については、BigQueryINFORMATION_SCHEMA
の概要をご覧ください。