ノートブックを作成する

プレビュー

このプロダクトまたは機能には、サービス固有の利用規約の「一般的なサービス規約」の「pre-GA サービス規約」が適用されます。 一般提供前のプロダクトと機能は「現状のまま」ご利用いただけますが、サポートが制限される場合があります。 詳しくは、リリース ステージの説明をご覧ください。

プレビュー版のサポートについては、[e-mail] までメールでお問い合わせください。

このドキュメントでは、BigQuery で Colab Enterprise ノートブックを作成する方法について説明します。ノートブックは、Dataform が提供する BigQuery Studio コードアセットです。

始める前に

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

2. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

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

   プロジェクト セレクタに移動

3. Google Cloud プロジェクトで課金が有効になっていることを確認します。

4. BigQuery API を有効にします。

   API を有効にする

5. Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。

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

   プロジェクト セレクタに移動

6. Google Cloud プロジェクトで課金が有効になっていることを確認します。

7. BigQuery API を有効にします。

   API を有効にする

BigQuery Studio を有効にする

アセット管理に関する BigQuery Studio を有効にするの手順に沿って、コードアセット（ノートブックなど）のバージョンを保存、共有、管理します。

必要な権限

ノートブックを作成、編集、表示するための適切な権限を設定します。

Dataform 管理者（roles/dataform.admin）ロールを持つすべてのユーザーは、プロジェクトで作成されたすべてのノートブックに対するオーナー アクセス権を持ちます。

BigQuery Identity and Access Management（IAM）の詳細については、IAM によるアクセス制御をご覧ください。

ノートブックを作成する権限

ノートブックを作成して実行するには、次の IAM 権限が必要です。

• resourcemanager.projects.get
• resourcemanager.projects.list
• bigquery.config.get
• bigquery.jobs.create
• bigquery.readsessions.create
• bigquery.readsessions.getData
• bigquery.readsessions.update
• resourcemanager.projects.get
• resourcemanager.projects.list
• dataform.locations.get
• dataform.locations.list
• dataform.repositories.create
• dataform.repositories.list
• dataform.collections.create
• dataform.collections.list
• aiplatform.notebookRuntimeTemplates.apply
• aiplatform.notebookRuntimeTemplates.get
• aiplatform.notebookRuntimeTemplates.list
• aiplatform.notebookRuntimeTemplates.getIamPolicy
• aiplatform.notebookRuntimes.assign
• aiplatform.notebookRuntimes.get
• aiplatform.notebookRuntimes.list
• aiplatform.operations.list

これらの権限は、次の IAM ロールから取得できます。

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

• BigQuery Studio ユーザー（roles/bigquery.studioUser）

  BigQuery Studio ユーザーのロールは、次の IAM ロールを組み合わせたものです。

  • BigQuery ジョブユーザー（roles/bigquery.jobUser）
  • ノートブック ランタイム ユーザー（roles/aiplatform.notebookRuntimeUser）

  • コード作成者（roles/dataform.codeCreator）

    注: プロジェクトでコード作成者ロールが割り当てられているユーザーは、Dataform API または Dataform コマンドライン インターフェース（CLI）を使用して、そのプロジェクトのコードアセットの名前を一覧表示できます。プレビュー版では、BigQuery Studio を使用する管理者以外のユーザーは、自身が作成したコードアセットまたは自分と共有されているコードアセットのみを表示できます。

ノートブックを編集する権限

ノートブックを編集して実行するには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• ノートブック ランタイム ユーザー（roles/aiplatform.notebookRuntimeUser）
• コードエディタ（roles/dataform.codeEditor）

ノートブックを表示する権限

ノートブックを表示して実行するには、次の IAM ロールが必要です。

• BigQuery ジョブユーザー（roles/bigquery.jobUser）
• BigQuery 読み取りセッション ユーザー（roles/bigquery.readSessionUser）
• ノートブック ランタイム ユーザー（roles/aiplatform.notebookRuntimeUser）
• コード閲覧者（roles/dataform.codeViewer）

ノートブックを作成する

ノートブックの作成方法については、次のセクションをご覧ください。

コードアセットにデフォルトのリージョンを設定する

コードアセットを初めて作成する場合は、コードアセットのデフォルト リージョンを設定します。コードアセットのリージョンを作成後に変更することはできません。

注: 保存済みクエリを作成し、コードアセットに使用しているリージョンとは異なるデフォルト リージョンを選択する（たとえば us-west1 使用している場合に us-central1を選択する）と、そのクエリと、その後に作成したすべてのコードアセットでは、デフォルトで新しいリージョンが使用されます。既存のコードアセットでは、作成時に割り当てられたリージョンが引き続き使用されます。

BigQuery エディタからノートブックを作成する

特定のテーブル用のデフォルト クエリを含むノートブックを作成する手順は、次のとおりです。

1. [BigQuery] ページに移動します。

   [BigQuery] に移動

2. エディタペインのタブバーで、+ 記号の横にある 矢印プルダウンをクリックし、[新しい Python ノートブックを作成] をクリックします。

   

   新しいノートブックが開き、bigquery-public-data.ml_datasets.penguins 一般公開データセットに対するクエリの例を示すセルが含まれています。

テーブルからノートブックを作成する

特定のテーブル用のデフォルト クエリを含むノートブックを作成する手順は、次のとおりです。

1. [BigQuery] ページに移動します。

   [BigQuery] に移動

2. [エクスプローラ] ペインで、クエリを実行するテーブルを見つけます。

3. テーブルの横にある （アクションを表示）をクリックし、[クエリ] > [Python ノートブック] をクリックします。

   新しいノートブックが開き、選択したテーブルに対するクエリの例が表示されます。

クエリの結果セットを調べるためのノートブックを作成する

クエリの結果セットを調べるノートブックを作成する手順は次のとおりです。

1. [BigQuery] ページに移動します。

   [BigQuery] に移動

2. エディタペインで、クエリ結果を生成するクエリを実行します。

3. [クエリ結果] ペインで [データを探索] をクリックし、[Python ノートブックで探索] をクリックします。

   新しいノートブックが開き、クエリ SQL とクエリ結果を返すコードを含むセルが表示されます。

既存のノートブックからノートブックを作成する

既存のノートブックの任意のバージョンを新しいノートブックとして開く手順は、次のとおりです。

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ノートブックを選択します。
2. [アクティビティ] ペインを選択します。

3. ノートブック バージョンの横にある （アクションを表示）をクリックし、[新しい Python ノートブックとして開く] をクリックします。

   ノートブックのコピーが新しいノートブックとして開かれます。

ノートブックをアップロードする

ノートブックは、Google Cloud コンソールで Vertex AI を使用してアップロードできます。アップロードされたノートブックは、Google Cloud コンソールの BigQuery ページにも表示されます。詳細については、ノートブックをアップロードするをご覧ください。

ランタイムに接続する

以降のセクションでは、ノートブックを Vertex AI ランタイムに接続する方法について説明します。ランタイムは、ノートブックでコードを実行するコンピューティング リソースです。

デフォルトのランタイムに接続する

デフォルトのランタイムは、最小限の設定が必要なプリセット ランタイムです。

デフォルトのランタイムに接続する手順は、次のとおりです。

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

2. ノートブックで [接続] をクリックするか、ノートブックの任意のセルを実行します。

   アクティブなランタイムがない場合、デフォルトのランタイムへの接続に数分かかることがあります。

デフォルト以外のランタイムに接続する

デフォルト ランタイム以外のランタイムを使用する場合は、まず Vertex AI で追加のランタイムを作成する必要があります。

デフォルト以外のランタイムに接続する手順は、次のとおりです。

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ノートブックの名前をクリックして開きます。
2. ノートブックで、[接続] の横にある プルダウンをクリックし、[Connect to a runtime] をクリックします。
3. [既存のランタイムに接続します] をクリックします。
4. [ランタイム] で、使用するランタイムを選択します。
5. [接続] をクリックします。

新しいランタイムに接続する

新しいランタイムに接続する手順は、次のとおりです。

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ノートブックの名前をクリックして開きます。
2. ノートブックで、[接続] の横にある プルダウンをクリックし、[Connect to a runtime] をクリックします。
3. [ランタイムを新規作成します] をクリックします。
4. [ランタイム テンプレート] で、使用する Vertex AI ランタイム テンプレートを選択します。
5. [ランタイム名] にランタイムの名前を入力します。
6. [接続] をクリックします。

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

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

重要: ノートブックにアクセスできるユーザーは、ノートブック内のコードによって生成されたすべての出力を表示できます。自分がアクセスできないテーブルのデータが含まれた出力でも表示できます。

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクセス権を付与するノートブックを見つけます。
2. ノートブックの横にある （アクションを表示）をクリックし、[権限の管理] をクリックします。
3. [プリンシパルを追加] をクリックします。
4. [新しいプリンシパル] フィールドに、プリンシパルを入力します。

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

   • コードオーナー: ノートブックの削除や共有など、ノートブックに対するあらゆるアクションを実行できます。
   • コードエディタ: ノートブックを編集できます。
   • コード閲覧者: ノートブックを表示できます。
   注: また、ノートブックを実行するには、プリンシパルにノートブック ランタイム ユーザー（roles/aiplatform.notebookRuntimeUser）と BigQuery ユーザー（roles/bigquery.user）のロールが必要です。

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

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

ノートブックを共有する

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

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

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。共有するノートブックを見つけます。
2. ノートブックの横にある （アクションを表示）をクリックし、[リンクを取得] をクリックします。
3. リンクを他のユーザーと共有します。

競合の解決

ユーザーと別のユーザーがノートブックで競合する変更を加えると、Automatic saving failed. This file was updated remotely or in another tab. エラーが返され、Show diff リンクが提供されます。競合を解決する手順は次のとおりです。

1. Show diff リンクをクリックします。[リモート変更の確認] ダイアログが開きます。
2. 省略可: ノートブックのソースコードを比較するには、[元の形式のソース] チェックボックスをオンにします。
3. 省略可: 個別のペインではなく、インラインでバージョンを比較するには、[インラインで差分を表示] チェックボックスをオンにします。
4. 変更内容を確認して、どれを残すかを判断し、必要に応じて入力を変更します。
5. [変更を保存] をクリックします。

ノートブックの名前を変更する

ノートブックの名前を変更する手順は、次のとおりです。

1. [エクスプローラ] ペインで、[ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。名前を変更するノートブックを見つけます。
2. ノートブックの横にある （アクションを表示）をクリックし、[名前を変更] をクリックします。
3. ノートブックの名前を入力して、[名前を変更] をクリックします。

トラブルシューティング

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

次のステップ

• ノートブックを管理する方法を確認する。