管理笔记本

注意：BigQuery Studio 笔记本将于 2024 年 4 月 11 日之后在正式版中开始收费。您将开始在账单中看到 BigQuery Studio 笔记本基于用量的费用。

本文档介绍了如何管理 BigQuery 中的 Colab Enterprise 笔记本，包括如何查看、比较、恢复、安排和删除笔记本。

笔记本是由 Dataform 提供支持的 BigQuery Studio 代码资产。

如需使用笔记本，您必须先启用 BigQuery Studio 以进行资产管理。

重要提示：2024 年 3 月，系统已自动为所有现有 BigQuery 项目启用支持 BigQuery Studio 功能的 API。新的 BigQuery 项目默认启用了这些 API。如需了解详情，请参阅自动启用 BigQuery Studio API。

所需权限

如需共享笔记本，您需要以下 Identity and Access Management (IAM) 角色：

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• 资源层级的 Code Owner (roles/dataform.codeOwner)。

如需保存和删除笔记本，您需要以下 IAM 角色：

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)
• Code Owner (roles/dataform.codeOwner) 或 Code Editor (roles/dataform.codeEditor)

如需使用笔记本修订版本，您需要以下 IAM 角色：

• BigQuery Job User (roles/bigquery.jobUser)
• BigQuery Read Session User (roles/bigquery.readSessionUser)

• 以下任何角色：

  • Code Owner (roles/dataform.codeOwner)
  • Code Editor (roles/dataform.codeEditor)
  • Code Viewer (roles/dataform.codeViewer)

如需创建笔记本时间表（预览版），您需要拥有以下角色：

• Dataform Admin (roles/dataform.admin)
• BigQuery Read Session User (roles/bigquery.readSessionUser) 或 BigQuery Studio User (roles/bigquery.studioUser)

如需修改笔记本时间表（预览版），您需要拥有 Dataform Editor (roles/dataform.editor) 角色。

如需查看笔记本时间表（预览版），您需要拥有 Dataform Viewer (roles/dataform.viewer) 角色。

如需详细了解 BigQuery IAM，请参阅使用 IAM 进行访问权限控制。

授予对笔记本的访问权限

若要向其他用户授予对笔记本的访问权限，请将这些用户添加到相应的 IAM 角色。

重要提示：有权访问笔记本的用户可以查看由笔记本中的代码生成的所有输出，即使此输出包含他们无权访问的表中的数据也是如此。如需禁止共享保存的输出，请停用笔记本输出保存。

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。找到您要授予其访问权限的笔记本。

3. 点击笔记本旁边的 查看操作，然后点击共享 > 管理权限。

4. 在管理权限窗格中，点击添加用户/群组。

5. 在新的主账号字段中，输入主账号。

6. 在角色列表中，选择以下角色之一：

   • Code Owner：可以对笔记本执行任何操作，包括删除或共享笔记本。
   • Code Editor：可以修改笔记本。
   • Code Viewer：可以查看笔记本。
   注意：主账号还必须拥有 Notebook Runtime User (roles/aiplatform.notebookRuntimeUser) 和 BigQuery User (roles/bigquery.user) 角色才能运行笔记本。

7. 可选：如需查看角色和高级共享设置的完整列表，请点击高级共享。

8. 点击保存。

9. 如需返回笔记本信息页面，请点击关闭。

共享笔记本

如需与其他用户共享笔记本，您可以生成并共享该笔记本的链接。如需让其他用户查看您共享的笔记本，您必须先授予对笔记本的访问权限。

如需运行笔记本，用户必须有权访问笔记本所访问的数据。如需了解详情，请参阅授予对数据集的访问权限。

重要提示：有权访问笔记本的用户可以查看由笔记本中的代码生成的所有输出，即使此输出包含他们无权访问的表中的数据也是如此。如需禁止共享保存的输出，请停用笔记本输出保存。

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。找到您要共享的笔记本。

3. 点击笔记本旁边的 查看操作，然后点击共享 > 复制链接。

4. 与其他用户共享该链接。

查看所有笔记本

如需查看项目中所有笔记本的列表，请执行以下操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，点击笔记本旁边的 查看操作，然后执行以下操作之一：

• 如需在当前标签页中打开该列表，请点击全部显示。
• 如需在新标签页中打开该列表，请点击在以下位置全部显示 > 新标签页。
• 如需在拆分标签页中打开该列表，请点击在以下位置全部显示 > 拆分标签页。

查看笔记本元数据

如需查看笔记本元数据，请按照以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要查看其元数据的笔记本的名称。

3. 查看摘要窗格，以查看有关笔记本的信息（例如笔记本使用的区域）及其上次修改日期。

使用笔记本版本

使用以下部分了解如何查看、比较和恢复笔记本的版本。

查看笔记本版本

如需查看笔记本版本，请按照以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击要查看其活动的笔记本的名称。

3. 点击活动标签页，可查看按日期降序排列的笔记本版本列表。

比较笔记本版本

如需比较笔记本版本，请按照以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要比较其版本信息的笔记本的名称。

3. 在活动标签页中，点击笔记本版本旁边的 查看操作，然后点击比较。

4. 在修订历史记录窗格中，使用版本下拉列表来选择要比较的版本。

5. 可选：如需比较笔记本源代码，请选中原始源代码复选框。

6. 可选：如需以内嵌方式（而不是在单独的窗格中）比较版本，请选中内嵌差异复选框。

7. 可选：如需在笔记本中隐藏命令输出，请清除显示输出复选框。

恢复笔记本版本

使用以下任一选项来恢复笔记本版本。通过从修订历史记录窗格进行恢复，您可以在选择恢复先前版本之前比较笔记本的当前版本和先前版本。恢复笔记本会创建新版本的笔记本，而不是覆盖当前版本。不会丢失版本历史记录。

“活动”窗格

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要恢复其先前版本的笔记本的名称。

3. 选择活动窗格。

4. 点击要恢复的笔记本版本旁边的 查看操作，然后点击恢复。

5. 点击确认。

修订历史记录

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要恢复其先前版本的笔记本的名称。

3. 选择活动窗格。

4. 点击笔记本版本旁边的 查看操作，然后点击比较。

5. 在修订历史记录窗格中，点击版本下拉列表旁边的 查看操作，然后点击恢复修订版本。

6. 点击确认。

下载笔记本

如需下载笔记本，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要下载的笔记本的名称。

3. 点击下载。

安排笔记本

预览

本产品或功能须遵守服务专用条款的“通用服务条款”部分中的“非正式版产品条款”。 正式发布前产品和功能“按原样”提供，可能仅提供有限支持。 如需了解详情，请参阅发布阶段说明。

如需针对笔记本时间安排提供反馈，请发送电子邮件至 [e-mail]。

您可以安排笔记本按指定的时间和频率自动运行，例如用于训练机器学习模型、调用外部 API 或运行 BigQuery DataFrames 代码。

您对笔记本进行的更改会自动保存，但只有您和有权访问笔记本的用户才能看到这些更改。如需使用笔记本的新版本更新时间表，您需要部署笔记本。通过部署笔记本，您可以使用笔记本的当前版本更新其时间表。时间表会运行笔记本的最新部署版本。

每个笔记本时间表都由自定义 Dataform 服务账号运行，您可以在创建时间表期间选择该账号。如需详细了解 Dataform 中的服务账号类型，请参阅 Dataform 中的服务账号简介。

Dataform 会将安排的笔记本运行的输出写入在创建时间表期间选择的 Cloud Storage 存储桶。

笔记本时间表使用标准 E2 运行时。适用 Colab Enterprise 运行时费用。您需要按照 E2 机器类型支付运行时处理费用。如需了解标准 E2 运行时的价格，请参阅 Colab Enterprise 价格。

启用笔记本时间安排

如需安排笔记本，您必须向计划用于笔记本时间表的 Dataform 自定义服务账号授予以下角色：

Notebook Executor User (roles/aiplatform.notebookExecutorUser)

请按照针对项目授予单个角色中的说明，针对所选项目向 Dataform 自定义服务账号授予 Notebook Executor User 角色。

Storage Admin (roles/storage.admin)

请按照将主账号添加到存储桶级层政策中中的说明，将您的自定义 Dataform 服务账号作为主账号添加到您计划用于存储安排的笔记本运行输出的 Cloud Storage 存储桶，并向此主账号授予 Storage Admin 角色。

Service Account User (roles/iam.serviceAccountUser)

请按照针对服务账号授予单个角色中的说明，将自定义 Dataform 服务账号添加为其主账号。换句话说，将自定义 Dataform 服务账号作为主账号添加到同一自定义 Dataform 服务账号。然后，向此主账号授予 Service Account User 角色。

此外，您还必须向默认 Dataform 服务账号授予以下角色：

Service Account Token Creator(roles/iam.serviceAccountTokenCreator)

请按照向自定义 Dataform 服务账号授予令牌创建访问权限中的说明，将默认 Dataform 服务账号作为主账号添加到自定义 Dataform 服务账号，并向此主账号授予 Service Account Token Creator 角色。

如需详细了解 Dataform 中的服务账号，请参阅 Dataform 中的服务账号简介。

创建时间表

如需安排笔记本，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击您要安排的笔记本的名称。

3. 点击安排。

4. 在安排笔记本窗格中的时间表名称字段中，输入时间表的名称。

5. 在运行时模板字段中，选择一个运行时。

6. 在服务账号字段中，选择一个自定义 Dataform 服务账号。

7. 在 Cloud Storage 存储桶字段中，点击浏览，然后选择或创建 Cloud Storage 存储桶。

   所选的自定义 Dataform 服务账号必须在所选存储桶中获得 Storage Admin IAM 角色。如需了解详情，请参阅启用笔记本时间安排。

8. 在时间表频率部分中，执行以下操作：

   1. 在重复频率下拉菜单中，选择安排的笔记本运行的频率。
   2. 在时间字段中，为安排的笔记本运行输入时间。
   3. 在时区下拉菜单中，选择时间表的时区。

9. 点击创建时间表。

创建时间表后，系统会自动部署笔记本的当前版本。如需使用笔记本的新版本更新时间表，请部署笔记本。

笔记本的最新部署版本会按所选的时间和频率运行。

部署笔记本

部署笔记本操作会使用笔记本的当前版本更新其时间表。时间表会运行笔记本的最新部署版本。

如需部署笔记本，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击部署。

相应的时间表会使用笔记本的当前版本进行更新。笔记本的最新部署版本会在安排的时间运行。

查看时间表详情

如需查看所选笔记本的时间表详情，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击查看时间表。

查看过往的执行情况

如需查看所选笔记本时间表的过往的执行情况，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击查看时间表，然后点击查看过往的执行情况。

停用时间表

如需对所选笔记本暂停安排的运行，而不删除时间表，您可以停用时间表。

如需为所选笔记本停用时间表，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击查看时间表。

4. 在时间表详情表格中的时间表状态行中，点击已启用时间表切换开关。

启用时间表

如需对停用的时间表恢复安排的运行，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击查看时间表。

4. 在时间表详情表格中的时间表状态行中，点击已停用时间表切换开关。

修改时间表

如需修改时间表，请按以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。点击所选笔记本的名称。

3. 点击查看时间表，然后点击修改。

4. 在安排笔记本对话框中，修改时间表，然后点击更新时间表。

查看所有时间表

如需查看项目中的所有笔记本时间表，请按以下步骤操作：

1. 在 Google Cloud 控制台中，前往编排页面。

   前往编排页面

2. 可选：如需查看所选时间表及其过往的运行情况的详细信息，请点击相应时间表的名称。

删除时间表

如需永久删除所选笔记本的时间表，请按以下步骤操作：

1. 在 Google Cloud 控制台中，前往编排页面。

   前往编排页面

2. 在所有时间表列表中，选择包含要删除的时间表的行。

3. 可选：如需一次删除多个时间表，请选择多行。

4. 点击删除。

5. 在随即显示的对话框中，点击删除。

删除笔记本

如需删除笔记本，请按照以下步骤操作：

1. 在 Google Cloud 控制台中，转到 BigQuery 页面。

   转到 BigQuery

2. 在探索器窗格中，展开您的项目和笔记本文件夹，然后根据需要展开共享笔记本文件夹。找到您要删除的笔记本。

3. 点击笔记本旁边的 查看操作，然后点击删除。

4. 如需确认删除，请在对话框中输入 delete。

5. 点击删除。

问题排查

如需了解详情，请参阅排查 Colab Enterprise 问题。

后续步骤

• 详细了解 BigQuery 中的 Colab Enterprise 笔记本。
• 了解如何创建笔记本。