Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

BigQuery Studio Git リポジトリでコードを管理する

BigQuery Studio Git リポジトリを使用すると、BigQuery Studio ファイルブラウザで SQL スクリプト、ノートブック、その他のコードアセットを直接バージョン管理できます。 Google Cloud コンソールを離れることなく、リモート Git リポジトリのクローン作成、ブランチの管理、Git オペレーションの実行を行うことができます。

従来のリポジトリと比較して、この統合では、左側のペインのユーザールートフォルダの下に、フォルダベースの合理化されたエクスペリエンスが提供されます。リモート Git リポジトリへの接続を維持しながら、標準のファイルやディレクトリなどのコードアセットを操作できます。

制限事項

BigQuery Studio Git リポジトリは、ユーザーのルートフォルダコンテキストに制限されており、非公開での使用を目的としています。これらのリポジトリを他のユーザーと共有しないでください。これらのリポジトリは、プロジェクト内のアセットを仮想的に表すユーザールートフォルダに表示されますが、技術的にはプロジェクトレベルで作成されます。
Git プロキシで Developer Connect アカウントコネクタを使用することはできません。
マウント場所内のファイルシステムオペレーションは、Dataform の割り当てを消費します。
ファイル数が多い、ファイルサイズが大きい、ブランチが多い、commit 履歴が深く複雑なリポジトリは、クローン作成に時間がかかります。クローン作成オペレーションがオペレーションタイムアウトを超え、リポジトリが正常に作成されないことがあります。コミット履歴が深いリポジトリのクローン作成時間を短縮するには、シャロークローンを作成します。必要に応じて、後でさらに commit を取得できます。
BigQuery Studio Git リポジトリマウントに保存されるノートブックファイルのサイズは 30 MB を超えることはできません。ファイルのサイズが 30 MB を超える場合は、マウントされた場所の外にある Colab ランタイムのローカルストレージに保存します。
マウントの外部で Git リポジトリに変更を加えた場合（左側のペインでファイルを編集または名前変更した場合など）、ノートブックのランタイムのマウント内に変更が表示されるまでに最大 60 秒かかることがあります。この期間は、CACHE_TTL_SECONDS パラメータをコンストラクタに渡すことで調整できます。
```
  FuseWidget(CACHE_TTL_SECONDS=NUMBER)
```
NUMBER は、キャッシュが有効なままになる秒数に置き換えます。この値を小さくすると、同期の頻度が増加し、Dataform の割り当てがより早く消費されます。

始める前に

Google Cloud プロジェクトで Developer Connect API を有効にします。

API を有効化

必要なロール

BigQuery Studio Git リポジトリでコードを管理するために必要な権限を取得するには、プロジェクトに対する Developer Connect OAuth ユーザー（roles/developerconnect.oauthUser）の IAM ロールを付与するよう管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織に対するアクセス権の管理をご覧ください。

この事前定義ロールには、BigQuery Studio Git リポジトリでコードを管理するために必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

BigQuery Studio Git リポジトリでコードを管理するには、次の権限が必要です。

resourcemanager.projects.get
resourcemanager.projects.list
developerconnect.operations.list
developerconnect.operations.get
developerconnect.locations.list
developerconnect.locations.get
developerconnect.users.startOAuth
developerconnect.users.finishOAuth
developerconnect.users.fetchAccessToken
developerconnect.users.getSelf
developerconnect.users.deleteSelf
developerconnect.accountConnectors.get
developerconnect.accountConnectors.list
developerconnect.accountConnectors.gitProxyUse
developerconnect.accountConnectors.httpProxyUse
developerconnect.accountConnectors.gitProxyRead
developerconnect.accountConnectors.gitProxyWrite
developerconnect.accountConnectors.httpProxyRead
developerconnect.accountConnectors.httpProxyWrite
developerconnect.accountConnectors.fetchUserRepositories

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

リポジトリのセキュリティに関する考慮事項

BigQuery のコードアセットは Dataform を利用しているため、これらのアセットにアクセスできるユーザーに対して、次のセキュリティ上の影響を考慮する必要があります。

コードアセットの可視性は、プロジェクトレベルの Dataform 権限に則って管理されます。dataform.repositories.list 権限（BigQuery ジョブユーザー、BigQuery Studio ユーザー、BigQuery ユーザーなどの標準の BigQuery ロールに含まれる）を持つユーザーは、 Google Cloud プロジェクトの [エクスプローラ] パネルですべてのコードアセットを表示できます。これらのアセットを作成したかどうか、またはこれらのアセットが共有されているかどうかは関係ありません。可視性を制限するには、dataform.repositories.list 権限を除外するカスタムロールを作成します。
Dataform サービスエージェントと共有されているシークレットには、これらのアセットを編集できるユーザーがアクセスできる可能性があります。認証情報を保護するには、信頼できるユーザーに作成権限と編集権限を制限し、Dataform サービスエージェントがアクセスできるシークレットを制限します。詳細については、パッケージのインストール中のシークレットへのアクセスをご覧ください。

詳細については、Dataform 権限のセキュリティに関する考慮事項をご覧ください。

BigQuery Studio Git リポジトリを作成する

Git リポジトリを作成する際は、次の要件を考慮してください。

リモート Git リポジトリが公共のインターネットに開かれていない場合（例: ファイアウォールの内側にある場合）、リモート Git リポジトリを Git リポジトリに接続できないことがあります。この場合は、必要な Dataform の外向き IP アドレス範囲をファイアウォールルールに追加して、保護されたリモートリポジトリへの接続を有効にします。
dataform.restrictGitRemotes 組織のポリシーで許可リストに登録されていないリモート Git リポジトリに接続する Git リポジトリを作成するには、まずリモート Git リポジトリをポリシーの allowedValues リストに追加してから、Git リポジトリを作成します。詳細については、リモートリポジトリを制限するをご覧ください。

Git リポジトリを作成するには、次の操作を行います。

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

BigQuery に移動
左側のペインで [ファイル] をクリックして、ファイルブラウザを開きます。

左側のペインが表示されていない場合は、 左ペインを開くをクリックしてペインを開きます。
ユーザーのルートノードの横にある（アクションを表示）> [作成] > [Git リポジトリ] をクリックします。
リモート Git リポジトリの URL を入力します。
BigQuery Studio は、既存の Developer Connect アカウントコネクタが使用可能かどうかを検出します。以下のいずれかをご検討ください。
- アカウントコネクタが見つかった場合、Git リポジトリの表示名が事前入力されます。これらの値は編集できます。
- アカウントコネクタが存在しない場合は、[アカウントコネクタを作成] をクリックして、新しいアカウントコネクタを作成します。
- Developer Connect アカウントコネクタを使用しない場合は、[別の接続タイプを使用する] をクリックして、HTTPS または SSH を使用して接続します。
省略可: commit 履歴が制限されたシャロークローンリポジトリを作成するには、[詳細オプション] をクリックし、[シャロークローン] チェックボックスをオンにします。
1. [Depth] フィールドに、制限付きの commit 履歴で取得する commit の数を入力します。
[接続] をクリックします。

ファイルの編集

ファイルを編集するには、SQL スクリプトやノートブックなどのファイルノードをクリックして、新しいエディタタブでファイルを開きます。

変更内容はすべて自動的に保存されます。

ファイルの管理

各アイテムに関連付けられた操作メニューを使用して、標準的な管理タスクを実行できます。これらのオプションにアクセスするには、ディレクトリまたはファイルの横にある（アクションを開く）をクリックします。

ディレクトリレベルでは、次のタスクを実行できます。

リポジトリに作成: SQL クエリ、ノートブック、データキャンバス、データ準備、ファイル、サブディレクトリなどの新しいコードアセットを作成します。
リポジトリにアップロード: ローカルマシンから選択したディレクトリに既存のファイルをインポートします。
名前を変更: ディレクトリの名前を変更します。
移動: ディレクトリを移動します。ディレクトリは、同じ Git リポジトリ内の別の場所にのみ移動できます。詳細については、ファイルとディレクトリを移動またはコピーするをご覧ください。
削除: ディレクトリとそのすべてのコンテンツをローカルワークスペースから完全に削除します。

ファイルレベルでは、次のタスクを実行できます。

開くまたは開く: デフォルトのエディタまたは特定のアプリケーション（特定のノートブック環境など）でファイルを表示します。
名前を変更: ファイル名を変更します。
コピー: ファイルのコピーを作成します。ファイルをコピーできるのは、同じ Git リポジトリ内のディレクトリのみです。
移動: 同じ Git リポジトリ内の別のディレクトリにファイルを移動します。詳細については、ファイルとディレクトリを移動またはコピーするをご覧ください。
ダウンロード: ファイルのコピーをローカルマシンに保存します。
削除: ワークスペースからファイルを削除します。

ファイルとディレクトリを移動またはコピーする

ファイルとディレクトリを移動またはコピーできますが、同じ Git リポジトリ内に残す必要があります。

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

BigQuery に移動
左側のペインで [ファイル] をクリックして、ファイルブラウザを開きます。
移動またはコピーするファイルまたはディレクトリを見つけます。
[アクションを開く] > [移動] または [コピー] をクリックします。
表示されたダイアログで、同じ Git リポジトリ内のターゲットディレクトリを選択します。
[移動] または [コピー] をクリックします。

変更を commit して push する

ローカルの編集内容をリモートリポジトリと同期する手順は次のとおりです。

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

BigQuery に移動
左側のペインで、 [リポジトリ] をクリックします。
省略可: 変更されたファイルにカーソルを合わせ、[差分を表示] をクリックして、ローカルバージョンと最後に commit されたバージョンを 1 行ずつ比較します。
[commit メッセージ] フィールドに、変更の説明を入力します。
[Commit] をクリックします。変更はローカルブランチの Git 履歴に保存されます。
[リモートブランチに push] をクリックします。変更はリモートリポジトリと同期されます。

新しいブランチをチェックアウトする

ローカルブランチを管理し、既存のローカルブランチまたはリモートトラッキングブランチに基づいて新しいローカルブランチを作成できます。

[リポジトリ] タブの [ブランチ] セクションに、チェックアウトされたローカルブランチが表示されます。CURRENT ラベルはアクティブなブランチを示し、DEFAULT ラベルはリポジトリのデフォルトブランチを示します。

新しいブランチをチェックアウトするには、次の操作を行います。

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

BigQuery に移動
左側のペインで、 [リポジトリ] をクリックします。
[ブランチ] セクションを開きます。
ブランチの横にある（アクションを開く）をクリックし、[新しいブランチをチェックアウト] をクリックします。
[ソースブランチ] メニューで、新しいブランチのベースにするブランチ（origin/main など）を選択します。
[ブランチ名] フィールドに、新しいブランチの名前を入力します。

注: リモートトラッキングブランチをソースとして選択した場合、[ブランチ名] フィールドには対応するブランチ名が事前に入力されます。
[購入手続き] をクリックします。BigQuery Studio は、まずソースブランチをチェックアウトします。指定されたブランチ名が新しいブランチを示している場合は、そのソースに基づいて作成されます。新しいブランチがアクティブブランチになり、Git リポジトリの内容が自動的に更新され、チェックアウトされたブランチの状態が反映されます。

commit 履歴を表示

アクティブなブランチの commit 履歴を表示できます。リポジトリがシャロークローンとして作成された場合、[ブランチの commit 履歴] ペインに、リポジトリの commit 履歴が制限されていることを示す情報バナーが表示されます。より多くの commit をフェッチすることで、ローカルの履歴を拡張できます。

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

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

BigQuery に移動
左側のペインで、 [リポジトリ] をクリックします。
メインのバージョン管理操作ボタンの横にある矢印プルダウンをクリックし、[commit 履歴を表示] をクリックします。

[ブランチの commit 履歴] ペインが開き、アクティブなブランチの commit 履歴が表示されます。
省略可: シャロークローンリポジトリの追加の commit を取得するには、[ブランチの commit 履歴] ペインで [取得] をクリックします。
1. [フェッチ（シャロークローン）] ダイアログの [フェッチする追加の commit] フィールドに、リポジトリ履歴から取得する追加の commit の数を入力します。
  
  0 を入力すると、追加の履歴 commit は取得されませんが、BigQuery Studio は標準のフェッチを実行してリモート参照とメタデータを同期します。
2. [取得] をクリックします。
  
  すべての commit が取得されるまで、必要に応じてフェッチを繰り返すことができます。

Git リポジトリマウント内のノートブックファイルにアクセスする

BigQuery Studio Git リポジトリ内からノートブックにアクセスすると、ホスト Git リポジトリをノートブックのランタイムにマウントできます。マウントは、リモート Git リポジトリをノートブックのランタイムのローカルリポジトリのように表示する接続です。これにより、ノートブックは同じリポジトリ内の他のファイルやクエリスクリプトに直接アクセスして、読み取りと書き込みを行うことができます。

Git リポジトリをマウントする

Git リポジトリをマウントするには、ノートブックで次の Python コードを実行します。

from google_dataform_fuse_widget import FuseWidget
FuseWidget()

ノートブックがマウントに接続されると、次の変更が行われます。

ノートブックセッションの現在の作業ディレクトリが更新され、Git リポジトリ内の相対パスが反映されます。これにより、パスベースのファイルアクセスが自動的に機能します。
ノートブックのランタイム上の Git リポジトリのパスが Python システムパスに追加されます。これにより、標準の Python インポートステートメントを使用して、Git リポジトリからクエリスクリプトとファイルをノートブックに直接読み込むことができます。

マウントと接続を管理する

ワークスペースを管理するには、次のコントロールを使用します。

ワークスペースをマウントする: Git リポジトリのマウントプロセスを開始します。マウントは共有リソースであるため、同じ Colab ランタイム上の複数のノートブックが同じ Git リポジトリを使用する場合、同じマウントを使用します。
ワークスペースのマウントを解除: Git リポジトリのマウントプロセスを停止します。ワークスペースをマウント解除すると、そのワークスペースを使用していた Colab ランタイム上のすべてのノートブックでマウントが使用できなくなります。
ワークスペースを接続: 現在のノートブックセッションのアクティブなマウントへの接続を開始します。接続すると、ノートブックの作業ディレクトリとシステムパスが更新され、Git リポジトリが含まれるようになります。これにより、ファイルにアクセスしてインポートできるようになります。
ワークスペースを切断する: 現在のノートブックセッションのマウント接続を終了し、デフォルトの状態にリセットします。切断しても、他のアクティブなノートブックセッションのマウント接続ステータスには影響しません。セッションの接続を終了するには、[ワークスペースを切断] ボタンを使用することをおすすめします。
修復: マウントまたは接続が使用できなくなった場合に、正常な状態に復元します。

マウントを初期化したら、[ステータス] バーでマウントのリアルタイムの健全性とアクティブなパスを確認します。考えられる健全性の状態は、接続済み、マウント済み、停止、異常です。