管理笔记本

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

本文档还介绍了如何在 Dataplex 中查看和管理笔记本元数据。

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

准备工作

1. 创建笔记本。
2. 如需在 Dataplex 中管理笔记本元数据，请确保已在您的 Google Cloud 项目中启用 Dataplex 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)

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

如需在 Dataplex 中管理笔记本元数据，请确保您拥有所需的 Dataplex 角色。

授予对笔记本的访问权限

若要向其他用户授予对笔记本的访问权限，请将这些用户添加到相应的 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. 可选：如需在笔记本中隐藏命令输出，请点击比较，然后取消选中显示输出。

恢复笔记本版本

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

“活动”窗格

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. 点击下载。

删除笔记本

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

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

   转到 BigQuery

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

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

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

5. 点击删除。

在 Dataplex 中管理元数据

借助 Dataplex，您可以存储和管理笔记本的元数据。默认情况下，Dataplex 中提供 Notebooks，无需额外配置。

您可以使用 Dataplex 管理所有 BigQuery 位置中的笔记本。在 Dataplex 中管理笔记本需遵守 Dataplex 配额和限制以及 Dataplex 价格。

Dataplex 会自动从笔记本中检索以下元数据：

• 数据资源名称
• 数据资产父级
• 数据资产位置
• 数据资产类型
• 相应的 Google Cloud 项目

Dataplex 会将笔记本记录为条目，并附带以下条目值：

系统条目组

Notebook 的系统条目组为 @dataform。如需在 Dataplex 中查看笔记条目的详细信息，您需要查看 dataform 系统条目组。如需了解如何查看条目组中的所有条目列表，请参阅 Dataplex 文档中的查看条目组的详细信息。

系统条目类型

Notebook 的系统条目类型为 dataform-code-asset。如需查看记事的详细信息，您需要查看 dataform-code-asset 系统条目类型，使用基于方面过滤器过滤结果，并将 dataform-code-asset 方面中的 type 字段设置为 NOTEBOOK。然后，选择所选记事本的条目。 如需了解如何查看所选条目类型的详细信息，请参阅 Dataplex 文档中的查看条目类型的详细信息。如需了解如何查看所选条目的详细信息，请参阅 Dataplex 文档中的查看条目的详细信息。

系统方面类型

记事本的系统方面类型为 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 笔记本。
• 了解如何创建笔记本。
• 了解如何编排笔记本。