ノートブックを管理する
このドキュメントでは、ノートブックの表示、比較、復元、スケジュール設定、削除の方法など、BigQuery で Colab Enterprise ノートブックを管理する方法について説明します。
ノートブックは、Dataform が提供する BigQuery Studio コードアセットです。
ノートブックを使用するには、まずアセット管理に関する BigQuery Studio を有効にする必要があります。
必要な権限
ノートブックを共有するには、次の 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
) 次のいずれかのロール:
ノートブックのスケジュール(プレビュー)を作成するには、次のロールが必要です。
- Dataform 管理者(
roles/dataform.admin
) - BigQuery 読み取りセッション ユーザー(
roles/bigquery.readSessionUser
)または BigQuery Studio ユーザー(roles/bigquery.studioUser
)
ノートブックのスケジュール(プレビュー)を編集するには、Dataform 編集者(roles/dataform.editor
)のロールが必要です。
ノートブックのスケジュール(プレビュー)を表示するには、Dataform 閲覧者(roles/dataform.viewer
)のロールが必須です。
BigQuery IAM の詳細については、IAM でのアクセス制御をご覧ください。
ノートブックへのアクセス権を付与する
他のユーザーにノートブックへのアクセス権を付与するには、そのユーザーを適切な IAM ロールに追加します。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクセス権を付与するノートブックを見つけます。
ノートブックの横にある > [権限の管理] をクリックします。
(アクションを表示)をクリックし、[共有][権限を管理] ペインで、[ユーザー / グループの追加] をクリックします。
[新しいプリンシパル] フィールドに、プリンシパルを入力します。
[ロール] リストで、次のいずれかのロールを選択します。
省略可: ロールと詳細な共有設定の完全なリストを表示するには、[詳細な共有] をクリックします。
[保存] をクリックします。
ノートブック情報ページに戻るには、[閉じる] をクリックします。
ノートブックを共有する
ノートブックを他のユーザーと共有するには、ノートブックへのリンクを生成して共有します。共有したノートブックを他のユーザーに表示するには、最初にノートブックへのアクセス権を付与する必要があります。
ノートブックを実行するには、ノートブックがアクセスするデータにユーザーがアクセスできる必要があります。詳細については、データセットへのアクセス権を付与するをご覧ください。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。共有するノートブックを見つけます。
ノートブックの横にある > [リンクをコピー] をクリックします。
(アクションを表示)をクリックし、[共有]リンクを他のユーザーと共有します。
すべてのノートブックを表示する
プロジェクト内のすべてのノートブックのリストを表示するには、次の手順を行います。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、[Notebooks] の横にある
(アクションを表示)をクリックし、次のいずれかを行います。
- 現在のタブでリストを開くには、[すべて表示] をクリックします。
- リストを新しいタブで開くには、[すべてを表示] > [新しいタブ] をクリックします。
- 分割タブでリストを開くには、[すべてを表示] > [タブを分割] をクリックします。
ノートブックのメタデータを表示する
ノートブックのメタデータを表示する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。メタデータを表示するノートブックの名前をクリックします。
[概要] ペインで、データに使用するリージョンや最終更新日など、ノートブックに関する情報を確認します。
ノートブックのバージョンを操作する
以降のセクションでは、ノートブックのバージョンを表示、比較、復元する方法について説明します。
ノートブックのバージョンを表示する
ノートブックのバージョンを表示する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。アクティビティを表示するノートブックの名前をクリックします。
[アクティビティ] タブをクリックすると、ノートブックのバージョンが日付の降順で表示されます。
ノートブックのバージョンを比較する
ノートブックのバージョンを比較する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。バージョン情報を比較するノートブックの名前をクリックします。
[アクティビティ] タブで、ノートブック バージョンの横にある
(アクションを表示)をクリックし、[比較] をクリックします。[変更履歴] ペインで、[バージョン] プルダウンを使用して、比較するバージョンを選択します。
省略可: ノートブックのソースコードを比較するには、[元の形式のソース] チェックボックスをオンにします。
省略可: 個別のペインではなく、インラインでバージョンを比較するには、[インラインで差分を表示] チェックボックスをオンにします。
省略可: ノートブックのコマンド出力を非表示にするには、[出力を表示] チェックボックスをオフにします。
ノートブックのバージョンを復元する
ノートブックのバージョンを復元するには、次のいずれかのオプションを使用します。[変更履歴] ペインから復元すると、以前のバージョンの復元を選択する前に、ノートブックの現在のバージョンと以前のバージョンを比較できます。ノートブックを復元すると、現在のバージョンを上書きするのではなく、新しいバージョンのノートブックが作成されます。変更履歴が失われることはありません。
アクティビティ ペイン
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。以前のバージョンを復元するノートブックの名前をクリックします。
[アクティビティ] ペインを選択します。
復元するノートブックのバージョンの横にある
(アクションを表示)をクリックし、[復元] をクリックします。[Confirm] をクリックします。
変更履歴
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。以前のバージョンを復元するノートブックの名前をクリックします。
[アクティビティ] ペインを選択します。
ノートブック バージョンの横にある
(アクションを表示)をクリックし、[比較] をクリックします。[変更履歴] ペインで、[バージョン] プルダウンの横にある
(アクションを表示)をクリックして、[以前のリビジョンを復元] をクリックします。[Confirm] をクリックします。
ノートブックをダウンロードする
ノートブックをダウンロードする手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。ダウンロードするノートブックの名前をクリックします。
[ダウンロード] をクリックします。
ノートブックのスケジュールを設定する
ノートブックのスケジューリングに関するフィードバックは、bigquery-notebooks-scheduling-support@google.com までメールでお送りください。
ノートブックをスケジュール設定して、指定した時間と頻度で自動的に実行できます。たとえば、ML モデルのトレーニング、外部 API の呼び出し、BigQuery DataFrames コードの実行などです。
ノートブックに加えた変更は自動的に保存されますが、変更内容は、自分自身とノートブックにアクセスできるユーザーのみが利用できます。新しいバージョンのノートブックでスケジュールを更新するには、ノートブックをデプロイする必要があります。ノートブックをデプロイすると、現在のバージョンのノートブックでスケジュールが更新されます。スケジュールは、デプロイされた最新バージョンのノートブックを実行します。
各ノートブックのスケジュールは、スケジュールの作成時に選択したカスタム Dataform サービス アカウントによって実行されます。Dataform のサービス アカウントの種類の詳細については、Dataform のサービス アカウントについてをご覧ください。
Dataform は、スケジュール作成時に選択した Cloud Storage バケットに、スケジュール設定されたノートブックの実行の出力を書き込みます。
ノートブックのスケジュールでは、標準の E2 ランタイムを使用します。Colab Enterprise のランタイムの料金が適用されます。ランタイム処理の料金は、E2 マシンタイプに基づいて請求されます。標準 E2 ランタイムの料金については、Colab Enterprise の料金をご覧ください。
ノートブックのスケジュール設定を有効にする
ノートブックのスケジュールを設定するには、ノートブックのスケジュールに使用するカスタム Dataform サービス アカウントに次のロールを付与する必要があります。
- ノートブック エグゼキュータ ユーザー(
roles/aiplatform.notebookExecutorUser
) - プロジェクトに単一のロールを付与するの手順に沿って、選択したプロジェクトのカスタム Dataform サービス アカウントにノートブック エグゼキュータ ユーザーのロールを付与します。
- ストレージ管理者(
roles/storage.admin
) - バケットレベルのポリシーにプリンシパルを追加するの手順に沿って、カスタム Dataform サービス アカウントをプリンシパルとして、スケジュール設定したノートブックの実行の出力を保存するために使用する Cloud Storage バケットに追加し、このプリンシパルにストレージ管理者のロールを付与します。
- サービス アカウント ユーザー(
roles/iam.serviceAccountUser
) - サービス アカウントに単一のロールを付与するの手順に沿って、カスタム Dataform サービス アカウントをプリンシパルとして自身に追加します。つまり、カスタム Dataform サービス アカウントをプリンシパルとして同じカスタム Dataform サービス アカウントに追加します。次に、このプリンシパルにサービス アカウント ユーザーのロールを付与します。
また、デフォルトの Dataform サービス アカウントに次のロールを付与する必要があります。
- サービス アカウント トークン作成者(
roles/iam.serviceAccountTokenCreator
) - カスタム Dataform サービス アカウントにトークン作成アクセス権を付与するの手順に沿って、デフォルトの Dataform サービス アカウントをプリンシパルとしてカスタム Dataform サービス アカウントに追加し、このプリンシパルにサービス アカウント トークン作成者のロールを付与します。
Dataform のサービス アカウントの詳細については、Dataform のサービス アカウントについてをご覧ください。
スケジュールを作成する
ノートブックのスケジュールを設定する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。スケジュール設定するノートブックの名前をクリックします。
[スケジュール] をクリックします。
[ノートブックのスケジュール設定] ペインの [スケジュール名] フィールドに、スケジュールの名前を入力します。
[ランタイム テンプレート] フィールドで、ランタイムを選択します。
[サービス アカウント] フィールドで、カスタム Dataform サービス アカウントを選択します。
[Cloud Storage バケット] フィールドで、[参照] をクリックして、Cloud Storage バケットを選択または作成します。
選択したカスタム Dataform サービス アカウントには、選択したバケットに対するストレージ管理者の IAM ロールを付与する必要があります。詳細については、ノートブックのスケジュール設定を有効にするをご覧ください。
[スケジュールの頻度] セクションで、次の操作を行います。
- [繰り返しの頻度] プルダウンで、ノートブックの実行スケジュールの頻度を選択します。
- [時刻] フィールドに、ノートブックの実行スケジュールを設定する時刻を入力します。
- [タイムゾーン] プルダウンで、スケジュールのタイムゾーンを選択します。
[スケジュールを作成] をクリックします。
スケジュールを作成すると、現在のバージョンのノートブックが自動的にデプロイされます。新しいバージョンのノートブックでスケジュールを更新するには、ノートブックをデプロイします。
ノートブックの最新のデプロイ バージョンが、選択した時間と頻度で実行されます。
ノートブックをデプロイする
ノートブックをデプロイすると、ノートブックの現在のバージョンでスケジュールが更新されます。スケジュールは、デプロイされた最新バージョンのノートブックを実行します。
ノートブックをデプロイする手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[デプロイ] をクリックします。
対応するスケジュールが、ノートブックの現在のバージョンで更新されます。デプロイされた最新バージョンのノートブックがスケジュールされた時間に実行されます。
スケジュールの詳細を表示する
選択したノートブックのスケジュールの詳細を表示する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[スケジュールを表示] をクリックします。
過去の実行を表示する
選択したノートブックのスケジュールの過去の実行を表示する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[スケジュールを表示] をクリックし、[過去の実行を表示] をクリックします。
スケジュールを無効にする
スケジュールを削除せずに、選択したノートブックのスケジュールされた実行を一時停止するには、スケジュールを無効にします。
選択したノートブックのスケジュールを無効にするには、次の操作を行います。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[スケジュールを表示] をクリックします。
スケジュールの詳細テーブルの [スケジュールの状態] 行で、[スケジュールが有効です] 切り替えボタンをクリックします。
スケジュールを有効にする
無効になっているスケジュールの実行を再開する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[スケジュールを表示] をクリックします。
スケジュールの詳細テーブルの [スケジュールの状態] 行で、[スケジュールが無効です] 切り替えボタンをクリックします。
スケジュールを編集する
スケジュールを編集する手順は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [ノートブック] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。選択したノートブックの名前をクリックします。
[スケジュールを表示] をクリックし、[編集] をクリックします。
[ノートブックのスケジュール設定] ダイアログでスケジュールを編集し、[スケジュールを更新] をクリックします。
すべてのスケジュールを表示する
プロジェクト内のすべてのノートブックのスケジュールを表示する手順は次のとおりです。
Google Cloud コンソールの [オーケストレーション] ページに移動します。
省略可: 選択したスケジュールと過去の実行の詳細を表示するには、スケジュールの名前をクリックします。
スケジュールを削除する
選択したノートブックのスケジュールを完全に削除する手順は次のとおりです。
Google Cloud コンソールの [オーケストレーション] ページに移動します。
すべてのスケジュールのリストで、削除するスケジュールを含む行を選択します。
省略可: 複数のスケジュールを一度に削除するには、複数の行を選択します。
[削除] をクリックします。
表示されるダイアログで [削除] をクリックします。
ノートブックを削除する
ノートブックの削除方法は次のとおりです。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] ペインで、プロジェクトと [Notebooks] フォルダを開き、必要に応じて [共有ノートブック] フォルダを開きます。削除するノートブックを見つけます。
ノートブックの横にある
(アクションを表示)をクリックし、[削除] をクリックします。削除を確定するには、ダイアログで「
delete
」と入力します。[削除] をクリックします。
トラブルシューティング
詳細については、Colab Enterprise のトラブルシューティングをご覧ください。
次のステップ
- BigQuery での Colab Enterprise ノートブックの詳細を確認する。
- ノートブックの作成方法を学習する。