ワークスペースを作成して使用する

このドキュメントでは、BigQuery でワークスペースを操作する方法について説明します。これには、次のタスクが含まれます。

  • ワークスペースの作成
  • ワークスペースの削除
  • ワークスペース内のファイルの操作
  • ワークスペース内のファイルのバージョン管理

始める前に

BigQuery リポジトリをまだ作成していない場合は、作成します。

必要なロール

ワークスペースへのアクセスは、親リポジトリに対して付与されたロールによって決まります。詳細については、必要なロールをご覧ください。

ワークスペースを作成する

ワークスペースの作成方法は、BigQuery リポジトリとサードパーティ リポジトリのどちらを使用するかによって異なります。

BigQuery リポジトリにワークスペースを作成する

BigQuery リポジトリに新しいワークスペースを作成する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. ワークスペースを作成するリポジトリを選択します。

  4. エディタで [ワークスペースを追加] をクリックします。

  5. [ワークスペースの作成] ペインの [ワークスペース ID] フィールドに、ワークスペースの一意の ID を入力します。

    ID には数字、英字、ハイフン、アンダースコアのみを使用できます。

  6. [作成] をクリックします。

サードパーティ リポジトリにワークスペースを作成する

サードパーティ リポジトリに新しいワークスペースを作成する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. ワークスペースを作成するリポジトリを選択します。

  4. エディタで [ワークスペースを追加] をクリックします。[ワークスペースの作成] ペインが開きます。

  5. ワークスペースに既存のブランチを使用するか、新しいブランチを使用するかによって、[既存のリモート ブランチ] ラジオボタンまたは [新しいブランチ] ラジオボタンを選択します。

  6. 使用するブランチを指定します。

    1. [既存のリモート ブランチ] ラジオボタンを選択した場合は、[リモート ブランチ] フィールドで既存のブランチを選択します。
    2. [新しいブランチ] ラジオボタンを選択した場合は、[ワークスペース ID] フィールドにブランチ名を入力します。サードパーティ リポジトリで作成するブランチ名は、BigQuery ワークスペース ID と同じです。

      ID には数字、英字、ハイフン、アンダースコアのみを使用できます。

  7. [作成] をクリックします。

ワークスペースにディレクトリを作成する

ワークスペースにディレクトリを作成する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. 追加オプションをクリックします。

  6. [リポジトリに作成] > [ディレクトリ] をクリックします。

  7. [ディレクトリ パスを追加] フィールドにディレクトリ パスを入力します。

  8. [ディレクトリを作成] をクリックします。

ワークスペース内のファイルを操作する

ワークスペースには新しいファイルを作成することも、既存のファイルをアップロードすることもできます。

リポジトリには次の種類のファイルを作成またはアップロードできます。

ファイルを作成する

ワークスペースにファイルを作成する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. 次のいずれかを行います。

    • 追加オプションをクリックします。
    • 既存のディレクトリを選択し、 操作オプションをクリックします。
  6. [リポジトリに作成] をクリックし、作成するファイルの種類をクリックします。

  7. [名前] フィールドにファイル名を入力します。

  8. 省略可: [親ディレクトリ] フィールドに、ファイルを作成するディレクトリのパスを入力します。

  9. [保存] をクリックします。

ファイルをアップロードする

ワークスペースにファイルをアップロードする手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. 次のいずれかを行います。

    • 追加オプションをクリックします。
    • 既存のディレクトリを選択し、 操作オプションをクリックします。
  6. [リポジトリにアップロード] をクリックし、アップロードするファイルの種類をクリックします。

  7. アップロード ペインで、次のいずれかを行います。

    • [ファイルのアップロード] フィールドで [参照] をクリックし、ファイルを選択して [開く] をクリックします。
    • [URL] フィールドに、ファイルの URL を入力します。
  8. 省略可: [親ディレクトリ] フィールドに、ファイルを作成するディレクトリのパスを入力します。

  9. [アップロード] をクリックします。

ファイルを削除する

ワークスペースからファイルを削除する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. 削除するファイルを選択し、 操作オプションをクリックして [削除] をクリックします。

  6. [削除] をクリックします。

ファイルでバージョン管理を使用する

このセクションでは、BigQuery のバージョン管理を使用してワークスペース内のファイルを追跡する方法について説明します。

BigQuery では、リポジトリ内のファイルに加えられた変更を追跡するために Git が使用されます。BigQuery リポジトリの場合、ユーザーは Git リポジトリを直接操作します。接続されたリポジトリの場合は、リポジトリの接続時に構成したリモート リポジトリのデフォルト ブランチを操作します。

BigQuery には、ワークスペースの変更のステータスに応じたバージョン管理オプションが表示されます。たとえば、commit されていないローカル変更がワークスペースにある場合にのみ、commit オプションが表示されます。ワークスペース内のファイルがデフォルトまたはデフォルト ブランチの正確なコピーである場合、[最新] というステータスが表示されます。

BigQuery に表示されるバージョン管理オプションは次のとおりです。

X 件の変更を commit
ワークスペースまたは選択した変更ファイルの X 件のローカル変更を commit します。commit されていない変更が表示されます。
デフォルト ブランチに push
commit された変更をデフォルトのブランチに push します。このオプションは、ワークスペースに commit されていない変更がなく、push されていない commit がある場合に、リポジトリで使用できます。
your-branch-name に push
commit された変更を your-branch-name に push します。このオプションは、ワークスペースに commit されていない変更がない場合に、サードパーティの Git リポジトリに接続されているリポジトリで使用できます。サードパーティ リポジトリのリモート ブランチ名は、BigQuery ワークスペース ID と同じです。
デフォルト ブランチから pull
デフォルトのブランチからの最近の変更でワークスペースを更新します。このオプションは、ワークスペースに commit されていない変更がない場合に、リポジトリで使用できます。
your-branch-name から pull
your-branch-name からの最近の変更でワークスペースを更新します。このオプションは、ワークスペースに commit されていない変更がない場合に、サードパーティの Git リポジトリに接続されているリポジトリで使用できます。サードパーティ リポジトリのリモート ブランチ名は、BigQuery ワークスペース ID と同じです。
前回の commit に戻す
ワークスペース内のファイルを前回の commit の状態に復元します。

変更を pull する

ワークスペースがリポジトリと同期されていない場合、pull オプションが表示されます。

リポジトリからワークスペースに変更を pull する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. ワークスペース ペインで、次の操作を行います。

    1. BigQuery リポジトリ内の場合は、[デフォルトのブランチから pull] をクリックします。
    2. サードパーティの Git リポジトリに接続されているリポジトリ内の場合は、次のいずれかを行います。

      1. [デフォルト ブランチから pull] をクリックして、サードパーティ リポジトリのデフォルト ブランチから pull します。
      2. [your-branch-name から pull] をクリックして、現在のワークスペースに対応するサードパーティ リポジトリのブランチから pull します。

変更を commit する

ワークスペースで変更を加えると、commit オプションが表示されます。すべてのローカル変更または選択したファイルを commit できます。ファイルの追加や変更を行った場合、ワークスペース ペインでそのファイルの横に青い点が表示されます。

ワークスペースからリポジトリに変更を commit する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. ワークスペース ペインで、[X 件の変更を commit] をクリックします。

  6. [変更の commit] ペインで、次の操作を行います。

    1. commit する変更ファイルを選択します。

      ファイルを選択しないと、すべてのローカル変更が commit されます。変更ファイルは、ファイルの状態、ファイル名、パスでフィルタできます。

    2. [commit メッセージを追加] フィールドに、commit の説明を入力します。

    3. [全ての変更を commit] または [X 件の変更を commit] をクリックします。

      ボタンの名称は、commit するファイルの選択によって異なります。

変更を push する

変更を commit すると、push オプションが表示されます。

ワークスペースからリポジトリに変更を push する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. ワークスペース ペインで、次の操作を行います。

    1. BigQuery リポジトリ内の場合は、[デフォルト ブランチに push] をクリックします。
    2. サードパーティの Git リポジトリに接続されているリポジトリ内の場合は、次のいずれかを行います。

      1. [デフォルト ブランチに push] をクリックして、サードパーティ リポジトリのデフォルト ブランチに push します。
      2. [your-branch-name に push] をクリックして、現在のワークスペースに対応するサードパーティ リポジトリのブランチに push します。

commit されていない変更を元に戻す

commit されていない変更を元に戻す手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. ワークスペース ペインで、バージョン管理ボタンの 矢印プルダウンをクリックし、[前回の commit に戻す] をクリックします。

マージの競合を解決する

ワークスペースのローカル変更がリポジトリのデフォルト ブランチに加えられた変更と互換性がない場合、マージの競合が発生することがあります。通常、複数のユーザーが同じファイルを同時に編集している場合に発生します。

一般に、別のユーザーが競合する変更をあるブランチに push した後に、同じブランチから pull すると、マージの競合が発生します。影響を受けるファイルを編集して、マージの競合を手動で解決する必要があります。

次のコードサンプルは、SQL ファイルに表示されるマージの競合を示しています。

    <<<<<<< HEAD
    SELECT 1 as CustomerOrders
    =======
    SELECT 1 as Orders
    >>>>>>> refs/heads/main

マージの競合を解決する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. 影響を受けるファイルを選択し、選択した変更を加えて編集します。

  6. 変更を commit します

  7. 省略可: 変更を push します

commit 履歴を表示する

commit 履歴を表示する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダを開きます。

  3. 操作するワークスペースを含むリポジトリを選択します。

  4. エディタで目的のワークスペースを見つけて、[開く] をクリックします。

    ワークスペース ペインが開きます。

    ワークスペース ペイン。

  5. ワークスペース ペインで、バージョン管理ボタンの 矢印プルダウンをクリックし、[commit 履歴を表示] をクリックします。

ワークスペースを削除する

ワークスペースとそのすべてのコンテンツを削除する手順は次のとおりです。

  1. Google Cloud コンソールで [BigQuery] ページに移動します。

    [BigQuery] に移動

  2. [エクスプローラ] ペインで、[リポジトリ] フォルダをクリックします。

  3. [Git リポジトリ] ペインで、削除するワークスペースを選択します。

  4. 操作オプションをクリックして、[削除] をクリックします。

  5. [削除] をクリックします。

次のステップ