bq コマンドラインツールの使用

bq は、BigQuery 用の Python ベースのコマンドラインツールです。このページには、bq コマンドラインツールの使用に関する一般的な情報が含まれています。

すべての bq コマンドとフラグの詳細なリファレンスについては、bq コマンドラインツールリファレンスをご覧ください。

始める前に

BigQuery コマンドラインツールを使用するには、その前に、Google Cloud Platform Console を使用してプロジェクトを作成または選択し、課金を有効化する必要があります。また、Google Cloud SDK をインストールする必要もあります。

Google アカウントにログインします。
Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。
GCP プロジェクトを選択または作成します。

注: このチュートリアルで作成するリソースをそのまま保持する予定でない場合、既存のプロジェクトを選択するのではなく、新しいプロジェクトを作成してください。チュートリアルの完了後にそのプロジェクトを削除すれば、プロジェクトとチュートリアルに関連するすべてのリソースを削除できます。

[リソースの管理] ページに移動
プロジェクトに対して課金が有効になっていることを確認します。

課金を有効にする方法について
Cloud SDK をインストールして初期化します。
新しいプロジェクトでは、BigQuery が自動的に有効になります。既存のプロジェクトで BigQuery を有効にするには、以下にアクセスします。 BigQuery API を有効にします。
APIを有効にする

Cloud SDK をダウンロードしてインストールする代わりに、Google Cloud Shell にプリインストールされているバージョンの SDK を使用することもできます。

一般的な使用方法

フラグの配置

bq は、グローバルフラグとコマンドフラグの 2 種類のフラグをサポートしています。これらは、次に示す順序で使用する必要があります。

    bq --global_flag [ARGUMENT] bq_command --command-specific_flag [ARGUMENT]

グローバルフラグ（共通フラグ）は、すべてのコマンドで使用できます。
コマンド固有のフラグは、特定のコマンドに適用されます。

複数のグローバルフラグまたはコマンド固有のフラグを区切るには、スペースを使用します。次に例を示します。

    bq --global_flag [ARGUMENT] --global_flag [ARGUMENT] bq_command --command-specific_flag [ARGUMENT] --command-specific_flag [ARGUMENT]

コマンド引数は、次のいずれかの方法で指定できます。

--flag=[ARGUMENT]
--flag='[ARGUMENT]'
--flag="[ARGUMENT]"
--flag [ARGUMENT]
--flag '[ARGUMENT]'
--flag "[ARGUMENT]"

これらの各メソッドは、BigQuery ドキュメント全体で使用されています。

コマンドによっては、引数の前後に一重引用符または二重引用符を使用する必要があります。これは、引数にスペース、カンマ、またはその他の特殊文字が含まれている多くのコマンドに当てはまります。次に例を示します。

bq query --nouse_legacy_sql 'select count(*) from `bigquery-public-data.samples.shakespeare`'

ブール値を持つフラグは、引数なしで指定できます。true または false を指定する場合は、=[ARGUMENT] を指定する必要があります。

たとえば、次のコマンドでは、ブール値フラグ --use_legacy_sql に対して、フラグの前に no を指定することによって、false を指定します。

bq query --nouse_legacy_sql 'select count(*) from `bigquery-public-data.samples.shakespeare`'

あるいは、フラグの引数として false を指定するには、次のように入力します。

bq query --use_legacy_sql=false 'select count(*) from `bigquery-public-data.samples.shakespeare`'

使用可能なグローバルフラグおよびコマンド固有のフラグのリストについては、bq コマンドラインツールリファレンスをご覧ください。

ヘルプの表示

次のコマンドを入力すると、bq コマンドラインツールのヘルプを表示できます。

インストールされている bq のバージョンを参照するには、「bq version」と入力します。
すべてのコマンドの一覧を参照するには、「bq help」と入力します。
グローバルフラグの一覧を参照するには、「bq --help」と入力します。
特定のコマンドのヘルプを参照するには、「bq help [COMMAND]」と入力します。
特定のコマンドのヘルプとグローバルフラグの一覧を参照するには、「bq [COMMAND] --help」と入力します。

デバッグ

次のコマンドを入力して、bq をデバッグすることができます。

送受信されたリクエストを確認する

--apilog=[PATH_TO_FILE] フラグを追加して、オペレーションのログをローカルファイルに保存します。bq は標準の REST ベースの API 呼び出しを行うことで動作します。これは、表示すると有用な場合があります。また、問題を報告するときにも、このログを添付すると有用です。ファイルパスの代わりに - または stdout を使用すると、コンソールにログが出力されます。--apilog を stderr に設定すると、標準のエラーファイルに出力されます。
エラーのトラブルシューティングに活用する

ジョブのステータスを取得する場合、またはテーブルやデータセットなどのリソースに関する詳細情報を表示する場合は、--format=prettyjson フラグを入力します。このフラグを使用すると、reason プロパティを含む JSON 形式のレスポンスが出力されます。reason プロパティを使用すると、トラブルシューティングの手順を参照できます。

コマンドラインフラグのデフォルト値の設定

コマンドラインフラグのデフォルト値は、コマンドラインツールの構成ファイル .bigqueryrc に含めることで設定できます。デフォルトのオプションを構成する前に、まず .bigqueryrc ファイルを作成する必要があります。このファイルは、任意のテキストエディタを使用して作成できます。.bigqueryrc ファイルを作成したら、--bigqueryrc グローバルフラグを使用してファイルへのパスを指定できます。

--bigqueryrc フラグが指定されていない場合は、BIGQUERYRC 環境変数が使用されます。これが指定されていない場合、パス ~/.bigqueryrc が使用されます。デフォルトのパスは $HOME/.bigqueryrc です。

`.bigqueryrc` へのフラグの追加

.bigqueryrc にコマンドラインフラグのデフォルト値を追加するには:

ヘッダーなしでファイルの先頭にグローバルフラグを配置します。
コマンド固有のフラグについては、コマンド名（大かっこ内）を入力し、その下に次の形式でコマンド固有のフラグ（1 行に 1 つ）を追加します。
```
[COMMAND]
--command-specific_flag=[ARGUMENT]
--command-specific_flag=[ARGUMENT]
```

.bigqueryrc にコマンドラインフラグを入力するときは、フラグの引数を =[ARGUMENT] の形式で指定する必要があります。

.bigqueryrc は、bq を実行するたびに読み取られるため、変更はすぐに反映されます。bq を対話モード（bq shell）で実行する場合、変更を反映するにはシェルを再起動する必要があります。

例

この例では、次のグローバルフラグのデフォルト値を設定します。

--apilog が stdout に設定されており、デバッグ情報がコンソールに出力されます。
--format が prettyjson に設定されており、人が読める JSON 形式でコマンド出力が表示されます。
--location が US マルチリージョンロケーションに設定されています。

この例では、次の query コマンド固有のフラグのデフォルト値を設定します。

標準 SQL をデフォルトのクエリ構文にするために、--use_legacy_sql を false に設定します。

注: .bigqueryrc では --nouse_legacy_sql を使用できません。
クエリ出力の行数を制御するために、--max_rows を 100 に設定します。
--maximum_bytes_billed が 10,000,000 バイト（10 MB）に設定されており、10 MB を超えるデータを読み取るクエリは失敗します。

この例では、次の load コマンド固有のフラグのデフォルト値を設定します。

--destination_kms_key を projects/myproject/locations/mylocation/keyRings/myRing/cryptoKeys/myKey に設定します。

credential_file = [PATH_TO_CREDENTIAL_FILE]
--apilog=stdout
--format=prettyjson
--location=US

[query]
--use_legacy_sql=false
--max_rows=100
--maximum_bytes_billed=10000000

[load]
--destination_kms_key=projects/myproject/locations/mylocation/keyRings/myRing/cryptoKeys/myKey

設定を確認するには、次のコマンドを入力します。

cat ~/.bigqueryrc

対話型シェルでの `bq` の実行

対話型シェルで、bq を実行することができます。ここでは、bq をコマンドの前に配置する必要がありません。対話モードを開始するには、「bq shell」と入力します。シェルを起動すると、プロンプトがデフォルトのプロジェクトの ID に変更されます。対話モードを終了するには、「exit」と入力します。

例

コマンドラインの例は、BigQuery ドキュメントの入門ガイドに多く記載されています。以下は、BigQuery リソースの作成、取得、一覧表示、削除、変更などの一般的なコマンドラインタスクへのリンクです。

リソースの作成

コマンドラインツールを使用してリソースを作成する方法については、次をご覧ください。

データファイルを使用してテーブルを作成する例については、データの読み込みをご覧ください。

リソースに関する情報の取得

コマンドラインツールを使用してリソースに関する情報を取得する方法については、次をご覧ください。

リソースの一覧表示

コマンドラインツールを使用してリソースを一覧表示する方法については、次をご覧ください。

リソースの更新

コマンドラインツールを使用してリソースを更新する方法については、次をご覧ください。

データの読み込み

コマンドラインツールを使用してデータを読み込む方法については、次をご覧ください。

データのクエリ

コマンドラインツールを使用してデータをクエリする方法については、次をご覧ください。

外部データソースの使用

コマンドラインツールを使用して外部データソースのデータをクエリする方法については、次をご覧ください。

データのエクスポート

コマンドラインツールを使用してデータをエクスポートする方法については、次をご覧ください。

BigQuery に保存されているデータのエクスポート

BigQuery Data Transfer Service の使用

BigQuery Data Transfer Service でコマンドラインツールを使用する方法については、次をご覧ください。