ノートブックを管理する

このドキュメントでは、ノートブックの表示、比較、復元、削除の方法など、BigQuery で Colab Enterprise ノートブックを管理する方法について説明します。

このドキュメントでは、Dataplex Universal Catalog でノートブック メタデータを表示および管理する方法についても説明します。

ノートブックは、Dataform が提供する BigQuery Studio コードアセットです。

始める前に

1. ノートブックを作成します。
2. Dataplex Universal Catalog でノートブックのメタデータを管理するには、 Trusted Cloud プロジェクトで Dataplex API が有効になっていることを確認します。

必要な権限

ノートブックを共有するには、次の Identity and Access Management（IAM）ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• リソースレベルのコードオーナー（roles/dataform.codeOwner）

ノートブックの保存と削除を行うには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• コードオーナー（roles/dataform.codeOwner）またはコード編集者（roles/dataform.codeEditor）

ノートブックのリビジョンを操作するには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）

• 次のいずれかのロール:

  • コードオーナー（roles/dataform.codeOwner）
  • コードエディタ（roles/dataform.codeEditor）
  • コード閲覧者（roles/dataform.codeViewer）

BigQuery IAM の詳細については、IAM でのアクセス制御をご覧ください。

Dataplex Universal Catalog でノートブック メタデータを管理するには、必要な Dataplex Universal Catalog ロールがあることを確認します。

ノートブックへのアクセス権を付与する

他のユーザーにノートブックへのアクセス権を付与するには、そのユーザーを適切な IAM ロールに追加します。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクセス権を付与するノートブックを見つけます。

3. ノートブックの横にある more_vert（アクションを表示）をクリックし、[共有] > [権限の管理] をクリックします。

4. [権限を管理] ペインで、[ユーザー / グループの追加] をクリックします。

5. [新しいプリンシパル] フィールドに、プリンシパルを入力します。

6. [ロール] リストで、次のいずれかのロールを選択します。

   • コードオーナー: ノートブックの削除や共有など、ノートブックに対するあらゆるアクションを実行できます。
   • コードエディタ: ノートブックを編集できます。
   • コード閲覧者: ノートブックを表示できます。

7. 省略可: ロールと詳細な共有設定の完全なリストを表示するには、[詳細な共有] をクリックします。

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

9. ノートブック情報ページに戻るには、[閉じる] をクリックします。

ノートブックを共有する

ノートブックを他のユーザーと共有するには、ノートブックへのリンクを生成して共有します。共有したノートブックを他のユーザーに表示するには、最初にノートブックへのアクセス権を付与する必要があります。

ノートブックを実行するには、ノートブックがアクセスするデータにユーザーがアクセスできる必要があります。詳細については、データセットへのアクセス権を付与するをご覧ください。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。共有するノートブックを見つけます。

3. ノートブックの横にある more_vert（アクションを表示）をクリックし、[共有] > [リンクをコピー] をクリックします。

4. リンクを他のユーザーと共有します。

すべてのノートブックを表示する

プロジェクト内のすべてのノートブックのリストを表示するには、次の手順を行います。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、[Notebooks] の横にある more_vert（アクションを表示）をクリックし、次のいずれかを行います。

• 現在のタブでリストを開くには、[すべて表示] をクリックします。
• リストを新しいタブで開くには、[すべてを表示] > [新しいタブ] をクリックします。
• 分割タブでリストを開くには、[すべてを表示] > [タブを分割] をクリックします。

ノートブックのメタデータを表示する

ノートブックのメタデータを表示する手順は次のとおりです。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。メタデータを表示するノートブックの名前をクリックします。

3. [概要] ペインで、データに使用するリージョンや最終更新日など、ノートブックに関する情報を確認します。

ノートブックのバージョンを操作する

ノートブックは、リポジトリの内部または外部のいずれかで作成できます。ノートブックのバージョニングの方法は、ノートブックがどこに存在するかによって異なります。

リポジトリ内でのノートブックのバージョニング

リポジトリは、BigQuery またはサードパーティ プロバイダ内に存在する Git リポジトリです。リポジトリのワークスペースを使用して、ノートブックのバージョン管理を行うことができます。詳細については、ファイルでバージョン管理を使用するをご覧ください。

リポジトリ外でのノートブックのバージョニング

以降のセクションでは、ノートブックのバージョンを表示、比較、復元する方法について説明します。

ノートブックのバージョンを表示する

ノートブックのバージョンを表示する手順は次のとおりです。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。バージョン履歴を表示するノートブックの名前をクリックします。

3. ノートブックのバージョンの一覧を日付の降順で表示するには、schedule [バージョン履歴] をクリックします。

ノートブックのバージョンを比較する

ノートブックのバージョンを比較する手順は次のとおりです。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。バージョン情報を比較するノートブックの名前をクリックします。

3. [schedule 変更履歴] をクリックします。

4. ノートブック バージョンの横にある more_vert（アクションを表示）をクリックし、[比較] をクリックします。比較ペインが開き、選択したノートブックのバージョンと現在のノートブックのバージョンが比較されます。

5. 省略可: 個別のペインではなくインラインでバージョンを比較するには、[比較]、[インライン] の順にクリックします。

6. 省略可: バージョンのソースコードを比較するには、[比較]、[元の形式のソースを表示] の順にクリックします。

7. 省略可: ノートブックのコマンド出力を非表示にするには、[比較] をクリックし、[出力を表示] の選択を解除します。

ノートブックのバージョンを復元する

比較ペインからノートブックのバージョンを復元すると、以前のバージョンの復元を選択する前に、ノートブックの現在のバージョンと以前のバージョンを比較できます。ノートブックを復元すると、現在のバージョンを上書きするのではなく、新しいバージョンのノートブックが作成されます。変更履歴が失われることはありません。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。以前のバージョンを復元するノートブックの名前をクリックします。

3. [schedule 変更履歴] をクリックします。

4. バージョンの横にある more_vert（アクションを表示）をクリックし、[比較] をクリックします。比較ペインが開き、選択したノートブックのバージョンと最新のノートブックのバージョンを比較します。

5. 比較後に以前のノートブック バージョンを復元する場合は、[復元] をクリックします。

6. [確認] をクリックします。

ノートブックをダウンロードする

ノートブックをダウンロードする手順は次のとおりです。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ダウンロードするノートブックの名前をクリックします。

3. [ダウンロード] をクリックします。

ノートブックを削除する

ノートブックの削除方法は次のとおりです。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。削除するノートブックを見つけます。

3. ノートブックの横にある more_vert（アクションを表示）をクリックし、[削除] をクリックします。

4. 削除を確定するには、ダイアログで「delete」と入力します。

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

Dataplex Universal Catalog でメタデータを管理する

Dataplex Universal Catalog を使用すると、ノートブックのメタデータを保存して管理できます。ノートブックは、追加の設定をせずにデフォルトのまま Dataplex Universal Catalog で使用できます。

Dataplex Universal Catalog を使用すると、すべての BigQuery のロケーションでノートブックを管理できます。Dataplex Universal Catalog でノートブックを管理する場合は、Dataplex Universal Catalog の割り当てと上限および Dataplex Universal Catalog の料金が適用されます。

Dataplex Universal Catalog は、ノートブックから次のメタデータを自動的に取得します。

• データアセット名
• データアセットの親
• データアセットのロケーション
• データアセットのタイプ
• 対応する Trusted Cloud プロジェクト

Dataplex Universal Catalog は、ノートブックを次の値を持つエントリとしてログに記録します。

システム エントリ グループ

ノートブックのシステム エントリ グループは @dataform です。Dataplex Universal Catalog でノートブック エントリの詳細を表示するには、dataform システム エントリ グループを表示する必要があります。エントリ グループ内のすべてのエントリのリストを表示する方法については、Dataplex のドキュメントのエントリ グループの詳細を表示するをご覧ください。

システム エントリのタイプ

ノートブックのシステム エントリタイプは dataform-code-asset です。ノートブックの詳細を表示するには、dataform-code-asset システム エントリ タイプを表示して、アスペクトベースのフィルタで結果をフィルタし、dataform-code-asset アスペクト内の type フィールドを NOTEBOOK に設定する必要があります。選択したノートブックのエントリを選択します。選択したエントリタイプの詳細を表示する手順については、Dataplex Universal Catalog ドキュメントのエントリタイプの詳細を表示するをご覧ください。選択したエントリの詳細を表示する手順については、Dataplex Universal Catalog ドキュメントのエントリの詳細を表示するをご覧ください。

システム アスペクト タイプ

ノートブックのシステム アスペクト タイプは dataform-code-asset です。ノートブック エントリにアスペクトをアノテーションして Dataplex のノートブックにコンテキストを追加するには、dataform-code-asset アスペクト タイプを表示して、アスペクトベースのフィルタで結果をフィルタし、dataform-code-asset アスペクト内の type フィールドを NOTEBOOK に設定します。エントリにアスペクトをアノテーションする方法については、Dataplex Universal Catalog ドキュメントのアスペクトを管理してメタデータを拡充するをご覧ください。

タイプ

データ キャンバスのタイプは NOTEBOOK です。このタイプでは、アスペクトベースのフィルタで aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK クエリを使用して、dataform-code-asset システム エントリ タイプと dataform-code-asset アスペクト タイプのノートブックをフィルタできます。

Dataplex Universal Catalog でアセットを検索する方法については、Dataplex Universal Catalog ドキュメントの Dataplex Universal Catalog でデータアセットを検索するをご覧ください。

トラブルシューティング

詳細については、Colab Enterprise のトラブルシューティングをご覧ください。

次のステップ

• BigQuery での Colab Enterprise ノートブックの詳細を確認する。
• ノートブックの作成方法を学習する。
• ノートブックのスケジュールを設定する方法を学習する。