ノートブックを作成する

注: BigQuery Studio ノートブックは、一般提供となる 2024 年 4 月 11 日以降、課金の対象となります。請求書には、BigQuery Studio ノートブックの使用量に基づく請求が表示されるようになります。

このドキュメントでは、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. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Make sure that billing is enabled for your Google Cloud project.

4. Enable the BigQuery API.

   Enable the API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Make sure that billing is enabled for your Google Cloud project.

7. Enable the BigQuery API.

   Enable the API

BigQuery Studio を有効にする

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

重要: 2024 年 3 月より、すべての既存の BigQuery プロジェクトで BigQuery Studio の機能をサポートする API が自動的に有効になります。新しい BigQuery プロジェクトでは、これらの API がデフォルトで有効になっています。詳細については、BigQuery Studio API の自動有効化をご覧ください。

必要な権限

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

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.create 権限を持つユーザーは、デフォルトの Dataform サービス アカウントと、そのサービス アカウントに付与されたすべての権限を使用してコードを実行できます。詳細については、Dataform 権限のセキュリティに関する考慮事項をご覧ください。

• 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. Google Cloud コンソールで [BigQuery] ページに移動します。

   [BigQuery] に移動

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

3. [アクティビティ] ペインを選択します。

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

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

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

ローカル ノートブックをアップロードして、BigQuery Studio で使用できるようにします。アップロードされたノートブックは、Google Cloud コンソールの BigQuery ページに表示されます。

ノートブックをアップロードするには、次の操作を行います。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインでプロジェクトを開き、次のいずれかを行います。

   • [ノートブック] の横にある （アクションを表示）> [Notebooks にアップロード] をクリックします。
   • Google Cloud プロジェクト名の横にある （アクションを表示）> [プロジェクトにアップロードする] > [Python ノートブック] をクリックします。

3. [ノートブックのアップロード] ダイアログの [ノートブック] フィールドで、[参照] をクリックして、アップロードするノートブックを選択します。

4. 省略可: [ノートブック名] フィールドで、ノートブック ファイルの名前を編集します。

5. [リージョン] フィールドで、ノートブックをアップロードするリージョンを選択します。

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

ノートブックが [エクスプローラ ペイン] に表示されます。

ランタイムに接続する

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

ランタイムの詳細については、ランタイムとランタイム テンプレートをご覧ください。

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

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

デフォルトのランタイムに接続するには、次の操作を行います。

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

   [BigQuery] に移動

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

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

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

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

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

デフォルト以外のランタイムに接続するには、次の操作を行います。

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

   [BigQuery] に移動

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

3. ノートブックで、[接続] の横にある プルダウンをクリックし、[Connect to a runtime] をクリックします。

4. [既存のランタイムに接続します] をクリックします。

5. [ランタイム] で、使用するランタイムを選択します。

6. [接続] をクリックします。

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

新しいランタイムに接続するには、次の操作を行います。

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

   [BigQuery] に移動

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

3. ノートブックで、[接続] の横にある プルダウンをクリックし、[Connect to a runtime] をクリックします。

4. [ランタイムを新規作成します] をクリックします。

5. [ランタイム テンプレート] で、使用する Vertex AI ランタイム テンプレートを選択します。

6. [ランタイム名] にランタイムの名前を入力します。

7. [接続] をクリックします。

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

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

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

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

   [BigQuery] に移動

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

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

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

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

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

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

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

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

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

ノートブックを共有する

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

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

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

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

   [BigQuery] に移動

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

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

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

ノートブックの出力保存を無効にする

ノートブックの出力保存を無効にすると、ノートブック ファイルにアクセスできる他のユーザーと保存済みのノートブック出力を共有できなくなります。

選択したノートブックの出力保存を無効にすると、BigQuery はノートブック ファイルに保存されているすべての出力を削除し、その後の実行の出力は保存されません。

ただし、ノートブックにアクセスできるユーザーは、次の方法で出力を表示できます。

• ノートブックを実行して、現在の出力を確認します。この出力は保存されません。
• ノートブックのアーカイブ バージョンとその出力をリビジョン履歴で確認します。

選択したノートブックの出力保存を無効にするには、次の操作を行います。

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

   [BigQuery] に移動

2. [エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、出力保存を無効にするノートブックを選択します。

3. （ヘッダーの表示 / 非表示を切り替え）> [編集] > [Notebook settings] をクリックします。

4. [Notebook settings] ウィンドウで、[Omit code cell output when saving this notebook] を選択します。

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

6. [再読み込み] をクリックします。

競合を解決する

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

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

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

ノートブックの名前を変更するには、次の操作を行います。

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

   [BigQuery] に移動

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

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

4. ノートブックの名前を入力して、[名前を変更] をクリックします。

トラブルシューティング

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

次のステップ

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