建立筆記本

本文件說明如何在 BigQuery 中建立 Colab Enterprise 筆記本。筆記本是 BigQuery Studio 程式碼資產，由 Dataform 提供支援。

事前準備

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.

   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.

   Go to project selector

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

7. Enable the BigQuery API.

   Enable the API

所需權限

設定建立、編輯或查看筆記本的適當權限。

所有具備 Dataform 管理員 (roles/dataform.admin) 角色的使用者，都能對專案中建立的所有 Notebook 擁有存取權。

如要進一步瞭解 BigQuery 身分與存取權管理 (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)
  • Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)

  • Code Creator (roles/dataform.codeCreator)

編輯 Notebook 的權限

如要編輯及執行筆記本，您必須具備下列 IAM 角色：

• BigQuery 作业使用者 (roles/bigquery.jobUser)
• BigQuery 讀取工作階段使用者 (roles/bigquery.readSessionUser)
• Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)
• 程式碼編輯器 (roles/dataform.codeEditor)

查看筆記本的權限

如要查看及執行筆記本，您必須具備下列 IAM 角色：

• BigQuery 作业使用者 (roles/bigquery.jobUser)
• BigQuery 讀取工作階段使用者 (roles/bigquery.readSessionUser)
• Notebook Runtime User (roles/aiplatform.notebookRuntimeUser)
• 程式碼檢視器 (roles/dataform.codeViewer)

建立筆記本

請參閱下列各節，瞭解如何建立 Notebook。

設定程式碼資產的預設區域

如果您是第一次建立程式碼資產，請為程式碼資產設定預設區域。建立程式碼資產後，就無法變更其地區。

BigQuery Studio 中的所有程式碼資產都會使用相同的預設區域。如要設定程式碼資產的預設區域，請按照下列步驟操作：

1. 前往「BigQuery」頁面

   前往 BigQuery

2. 在「Explorer」窗格中，找出已啟用程式碼資產的專案。

3. 按一下專案旁的 more_vert「View actions」，然後點選「Change my default code region」。

4. 在「區域」中，選取要用於程式碼資產的區域。

5. 按一下 [選取]。

如需可用地區的清單，請參閱 BigQuery Studio 位置。

透過 BigQuery 編輯器建立筆記本

如要建立包含特定資料表預設查詢的筆記本，請按照下列步驟操作：

1. 前往「BigQuery」頁面

   前往 BigQuery

2. 在編輯器窗格中的分頁列中，按一下「+」符號旁的 arrow_drop_down 箭頭下拉式選單，然後點選「建立 Python 筆記本」。

   新的筆記本會隨即開啟，其中包含顯示 bigquery-public-data.ml_datasets.penguins 公開資料集範例查詢的儲存格。

根據資料表建立筆記本

如要建立包含特定資料表預設查詢的筆記本，請按照下列步驟操作：

1. 前往「BigQuery」頁面

   前往 BigQuery

2. 在「Explorer」窗格中展開專案，然後找出要查詢的資料表。

3. 按一下資料表旁的 more_vert「View actions」，然後點選「Query in > Python notebook」。

   系統會開啟新的筆記本，其中的儲存格會顯示針對所選表格的範例查詢。

建立筆記本，探索查詢的結果集

如要建立筆記本來探索查詢的結果集，請按照下列步驟操作：

1. 前往「BigQuery」頁面

   前往 BigQuery

2. 在編輯器窗格中執行查詢，產生查詢結果。

3. 在「查詢結果」窗格中，依序按一下「探索資料」和「使用 Python 程式本探索」。

   新的筆記本會隨即開啟，其中包含含有程式碼的儲存格，可用來傳回查詢 SQL 和查詢結果。

使用現有筆記本建立筆記本

如要將現有筆記本的任何版本開啟為新筆記本，請按照下列步驟操作：

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

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，並視需要展開「Shared notebooks」資料夾。選取筆記本。

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

4. 按一下筆記本版本旁的 more_vert「查看動作」，然後點選「開啟為新的 Python 筆記本」。

   系統會以新筆記本的形式開啟筆記本副本。

上傳筆記本

您可以上傳本機筆記本，在 BigQuery Studio 中使用。接著，上傳的 Notebook 會顯示在 Google Cloud 控制台的「BigQuery」頁面中。

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

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

   前往 BigQuery

2. 在「Explorer」窗格中展開專案，然後執行下列任一操作：

   • 在「Notebooks」旁邊，按一下 more_vert「查看動作」>「上傳至 Notebooks」。
   • 在 Google Cloud 專案名稱旁邊，按一下 more_vert「View actions」>「Upload to project」>「Python notebook」。

3. 在「Upload Notebook」對話方塊的「Notebook」欄位中，按一下「Browse」，然後選取要上傳的筆記本。

4. 選用：在「Notebook name」欄位中編輯筆記本名稱。

5. 在「Region」(區域) 欄位中，選取要上傳筆記本的區域。

6. 按一下「上傳」。

筆記本會顯示在「Explorer」窗格中。

連線至執行階段

請參閱下列各節，瞭解如何將筆記本連結至 Vertex AI 執行階段。執行階段是執行筆記本程式碼的運算資源。

如要進一步瞭解執行階段，請參閱「執行階段和執行階段範本」。

連線至預設執行階段

預設執行階段是預先設定的執行階段，只需進行最少的設定。

如要連線至預設執行階段，請按照下列步驟操作：

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

   前往 BigQuery

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

3. 在筆記本中按一下「Connect」，或執行筆記本中的任何儲存格。

   如果沒有啟用的執行階段，連線至預設執行階段可能需要幾分鐘的時間。

連線至非預設執行階段

如果您想使用預設執行階段以外的執行階段，必須先在 Vertex AI 中建立其他執行階段。

如要連線至非預設的執行階段，請按照下列步驟操作：

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

   前往 BigQuery

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

3. 在 Notebook 中，按一下「Connect」旁的 arrow_drop_down 下拉式選單，然後點選「Connect to a runtime」。

4. 按一下「連線至現有的執行階段」。

5. 在「Runtimes」中，選取要使用的執行階段。

6. 按一下「連線」。

連線至新的執行階段

如要連線至新的執行階段，請按照下列步驟操作：

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

   前往 BigQuery

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

3. 在 Notebook 中，按一下「Connect」旁的 arrow_drop_down 下拉式選單，然後點選「Connect to a runtime」。

4. 按一下「建立新的執行階段」。

5. 在「執行階段範本」中，選取要使用的 Vertex AI 執行階段範本。

6. 在「Runtime name」(執行階段名稱) 中，輸入執行階段的名稱。

7. 按一下「連線」。

授予筆記本存取權

如要授予其他使用者 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 停用輸出內容儲存功能時，BigQuery 會刪除 Notebook 檔案中儲存的所有輸出內容，並不會儲存後續執行作業的輸出內容。

不過，有權存取筆記本的使用者仍可透過下列方式查看輸出內容：

• 執行筆記本，查看目前的輸出結果。系統不會儲存這項輸出內容。
• 在修訂版本記錄中查看筆記本的封存版本及其輸出內容。

如要停用所選筆記本的輸出儲存功能，請按照下列步驟操作：

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

   前往 BigQuery

2. 在「Explorer」窗格中展開專案和「Notebooks」資料夾，然後選取要停用輸出儲存功能的 Notebook。

3. 依序點選 arrow_drop_down「切換標題列可見度」>「編輯」>「筆記本設定」。

4. 在「筆記本設定」視窗中，選取「儲存這個筆記本時，忽略程式碼儲存格輸出內容」。

5. 按一下 [儲存]。

6. 按一下「重新載入」。

解決衝突

如果您和其他使用者在筆記本中進行互相衝突的變更，服務會擲回錯誤 Automatic saving failed. This file was updated remotely or in another tab.，並提供 Show diff 連結。如要解決衝突問題，請按照下列步驟操作：

1. 按一下 Show diff 連結。系統會開啟「查看遠端變更」對話方塊。
2. 選用：如要比較筆記本原始碼，請勾選「原始來源」核取方塊。
3. 選用步驟：如要比較版本內容，而非在個別窗格中比較，請選取「Inline diff」核取方塊。
4. 查看變更內容並決定要保留哪些內容，並視需要修改輸入內容。
5. 按一下「儲存變更」。

重新命名筆記本

如要重新命名筆記本，請按照下列步驟操作：

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

   前往 BigQuery

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

3. 按一下筆記本旁的 more_vert「View actions」(查看動作)，然後點選「Rename」(重新命名)。

4. 輸入記事本名稱，然後按一下「重新命名」。

疑難排解

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

後續步驟

• 瞭解如何管理 Notebook。
• 瞭解如何排定筆記的運作時間。