管理筆記本

本文說明如何管理 BigQuery 中的 Colab Enterprise 筆記本，包括如何查看、比較、還原及刪除筆記本。

本文件也說明如何在 Dataplex 通用目錄中查看及管理 Notebook 中繼資料。

筆記本是 BigQuery Studio 程式碼資產，由 Dataform 提供支援。

事前準備

1. 建立筆記本。
2. 如要在 Dataplex 通用目錄中管理 Notebook 中繼資料，請確認 Google Cloud 專案已啟用 Dataplex API。

所需權限

如要分享 Notebook，您必須具備下列 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)

• 下列任一角色：

  • Code Owner (roles/dataform.codeOwner)
  • 程式碼編輯器 (roles/dataform.codeEditor)
  • 程式碼檢視器 (roles/dataform.codeViewer)

如要進一步瞭解 BigQuery 身分與存取權管理，請參閱「使用身分與存取權管理功能控管存取權」。

如要管理 Dataplex Universal Catalog 中的 Notebook 中繼資料，請確認您具備必要的 Dataplex Universal Catalog 角色。

授予筆記本存取權

如要授予其他使用者 Notebook 的存取權，請將這些使用者加入適當的 IAM 角色。

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。找出要授予存取權的記事本。

3. 按一下記事本旁的 more_vert「查看動作」，然後依序點選「分享」>「管理權限」。

4. 在「管理權限」窗格中，按一下「新增使用者/群組」。

5. 在「新增主體」欄位中輸入主體。

6. 在「Role」清單中，選取下列其中一個角色：

   • 程式碼擁有者：可對筆記本執行任何動作，包括刪除或分享。
   • 程式碼編輯器：可編輯筆記本。
   • 程式碼檢視器：可查看筆記本。

7. 選用步驟：如要查看完整的角色清單和進階共用設定，請按一下「進階共用」。

8. 按一下 [儲存]。

9. 如要返回 Notebook 資訊頁面，請按一下「關閉」。

共用筆記本

如要與其他使用者共用筆記本，可以產生並分享筆記本的連結。如要讓其他使用者查看你共用的筆記本，你必須先授予存取權。

如要執行 Notebook，使用者必須能存取 Notebook 存取的資料。詳情請參閱「授予資料集存取權」。

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中，展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。找出要分享的記事本。

3. 按一下筆記本旁的 more_vert「查看動作」，然後依序點選「分享」>「複製連結」。

4. 與其他使用者分享連結。

查看所有筆記本

如要查看專案中所有 Notebook 的清單，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中，按一下「Notebooks」旁的 more_vert「View actions」，然後執行下列任一操作：

• 如要在目前的分頁中開啟清單，請按一下「全部顯示」。
• 如要在新分頁中開啟清單，請依序按一下「在新分頁中顯示所有內容」 >「新分頁」。
• 如要在分割分頁中開啟清單，請依序按一下「顯示所有內容」 >「分割分頁」。

查看筆記本中繼資料

如要查看筆記本中繼資料，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。按一下要查看中繼資料的筆記本名稱。

3. 查看「摘要」窗格，瞭解 Notebook 相關資訊，例如用於儲存資料的地區和上次修改的日期。

使用筆記本版本

你可以選擇在儲存庫內或外建立記事本。系統會根據筆記本的位置，以不同方式處理筆記本版本。

存放區中的筆記本版本管理

存放區是位於 BigQuery 或第三方供應商的 Git 存放區。您可以在存放區中使用工作區，對筆記本執行版本控制。詳情請參閱「使用檔案的版本控制功能」。

在存放區外管理筆記本版本

請參閱下列各節，瞭解如何查看、比較及還原筆記本版本。

查看筆記本版本

如要查看筆記本版本，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。按一下要查看版本記錄的筆記本名稱。

3. 如要依日期由高至低排序查看筆記本版本清單，請按一下 schedule「版本記錄」。

比較筆記本版本

如要比較筆記本版本，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。按一下要比較版本資訊的 Notebook 名稱。

3. 按一下 schedule「版本記錄」。

4. 按一下筆記本版本旁的 more_vert「View actions」(查看動作)，然後點選「Compare」(比較)。比較窗格隨即開啟，比較您選取的筆記本版本與目前的筆記本版本。

5. 選用：如要比較版本內容，而非在個別檢視窗中比較，請依序按一下「比較」和「內嵌」。

6. 選用步驟：如要比較版本的原始碼，請依序按一下「比較」和「顯示原始碼」。

7. 選用：如要隱藏筆記本中的指令輸出內容，請按一下「比較」，然後取消選取「顯示輸出內容」。

還原筆記本版本

從比較窗格還原 Notebook 版本時，您可以比較目前和先前版本的 Notebook，然後再選擇還原先前版本。還原筆記本時，系統會建立新版本的筆記本，而不會覆寫目前的版本。不會遺失任何版本記錄。

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中，展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。按一下要還原先前版本的筆記本名稱。

3. 按一下 schedule「版本記錄」。

4. 按一下版本旁的 more_vert「查看動作」，然後點選「比較」。比較窗格會隨即開啟，比較您選取的筆記本版本與最新的筆記本版本。

5. 如要在比較後還原先前的筆記版本，請按一下「還原」。

6. 按一下「確認」。

下載筆記本

如要下載筆記本，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。按一下要下載的記事本名稱。

3. 點選 [下載]。

刪除筆記本

如要刪除筆記本，請按照下列步驟操作：

1. 前往 Google Cloud 控制台的「BigQuery」BigQuery頁面。

   前往 BigQuery

2. 在「Explorer」窗格中，展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。找出要刪除的記事本。

3. 按一下筆記本旁的 more_vert「View actions」(查看動作)，然後點選「Delete」(刪除)。

4. 如要確認刪除，請在對話方塊中輸入 delete。

5. 點選「刪除」。

在 Dataplex 通用目錄中管理中繼資料

Dataplex 通用目錄可讓您儲存及管理筆記本的中繼資料。根據預設，Dataplex 通用目錄會提供 Notebook，無須額外設定。

您可以使用 Dataplex 通用目錄，管理所有 BigQuery 位置中的筆記本。在 Dataplex 通用目錄中管理筆記本時，請遵守 Dataplex 通用目錄配額和限制和 Dataplex 通用目錄定價。

Dataplex 通用目錄會自動從筆記簿擷取下列中繼資料：

• 資料資產名稱
• 資料資產父項
• 資料資產位置
• 資料資產類型
• 對應的 Google Cloud 專案

Dataplex Universal Catalog 會將筆記本記錄為項目，並使用下列項目值：

系統項目群組

筆記本的系統項目群組為 @dataform。如要查看 Dataplex Universal Catalog 中 Notebook 項目的詳細資料，您必須查看 dataform 系統項目群組。如需查看項目群組中所有項目清單的操作說明，請參閱 Dataplex Universal Catalog 說明文件中的「查看項目群組詳細資料」一節。

系統項目類型

筆記本的系統輸入類型為 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 通用目錄說明文件中的「管理切面並強化中繼資料」。

類型

資料畫布的類型為 NOTEBOOK。您可以使用 aspect:dataplex-types.global.dataform-code-asset.type=NOTEBOOK 查詢中的以切面為依據的篩選器，篩選 dataform-code-asset 系統輸入類型和 dataform-code-asset 切面類型中的筆記本。

如要瞭解如何在 Dataplex 通用目錄中搜尋資產，請參閱 Dataplex 通用目錄文件中的「在 Dataplex 通用目錄中搜尋資料資產」。

疑難排解

詳情請參閱「排解 Colab Enterprise 問題」。

後續步驟

• 進一步瞭解 BigQuery 中的 Colab Enterprise 筆記本。
• 瞭解如何建立 Notebook。
• 瞭解如何排定筆記的運作時間。