编写和运行笔记本 - Amazon Redshift

编写和运行笔记本

您可以使用笔记本在单个文档中组织、注释及共享多个 SQL 查询。您可以将多个 SQL 查询和 Markdown 单元格添加到笔记本中。笔记本提供了一种方法:通过使用多个查询和 Markdown 单元格,将与数据分析相关的查询和解释分组到单个文档中。您可以使用 Markdown 语法添加文本并设置外观格式,以便为数据分析任务提供上下文和其它信息。您可以与团队成员共享您的笔记本。

要使用笔记本,您必须为您的 IAM 主体(IAM 用户或 IAM 角色)添加笔记本的权限。作为最佳实践,我们建议将权限策略附加到 IAM 角色,然后根据需要将其分配给用户和组。有关更多信息,请参阅 Amazon Redshift 中的 Identity and Access Management。您可以向其中一个查询编辑器 v2 托管策略添加权限。有关更多信息,请参阅访问查询编辑器 v2

您可以按顺序运行所有笔记本单元格。笔记本的 SQL 查询单元格具有大多数与查询编辑器选项卡相同的功能。有关更多信息,请参阅编写和运行查询。以下是查询编辑器选项卡和笔记本中的 SQL 单元格之间的差异。

  • 在笔记本中,没有用于对 SQL 语句运行 Explain 的控件。

  • 在笔记本中,每个 SQL 单元格只能创建一个图表。

您可以将笔记本导出和导入到使用查询编辑器 v2 创建的文件中。文件扩展名为 .ipynb,文件大小最大可为 5 MB。SQL 和 Markdown 单元格存储在文件中。集群或工作组和数据库不会存储在导出的笔记本中。当您打开导入的笔记本时,您可以选择用于运行该笔记本的集群或工作组和数据库。运行 SQL 单元格后,可以在结果选项卡中选择是否将当前结果页显示为图表。查询的结果集不会存储在笔记本中。

在您使用全部运行运行来运行笔记本后,运行状态面板就会变为可用。选择 
                        Run status
                    图标以打开面板。此面板包含笔记本中最近全部运行运行的 SQL 单元格的状态摘要。如果您运行过多个 SQL 单元格,则可以一目了然地查看运行的状态、用时和一些有关运行的详细信息。您可以根据状态筛选显示的单元格:AllSucceededErrorIn progress、或Canceled。在编辑器中,您也可以使用此面板导航到 SQL 单元格。

创建笔记本
  1. 在导航器菜单中,选择 
                    Editor 编辑器

  2. 选择 ,然后选择笔记本

    默认情况下,笔记本中会显示 SQL 查询单元格。

  3. 在 SQL 查询单元格中,执行以下任一操作:

    • 输入查询。

    • 粘贴您复制的查询。

  4. (可选)选择 
                        New Markdown cell
                    图标,然后选择标记以添加 Markdown 单元格,在其中可以使用标准 Markdown 语法提供描述性或解释性文本。

  5. (可选)选择 
                        New SQL cell
                    图标,然后选择 SQL 以插入 SQL 单元格。

您可以使用 
            Rename
        (铅笔)图标重命名笔记本。


            More
        (更多)菜单中,您还可以对笔记本执行以下操作:

  • 
                Share
            与我的团队分享 – 按照标签的定义,与您的团队分享笔记本。有关更多信息,请参阅共享查询

  • 
                Export
            导出 – 将笔记本导出到扩展名为 .ipynb 的本地文件。

  • 
                Save
            保存版本 – 创建笔记本的一个版本。要查看笔记本的版本,请导航到已保存的笔记本并打开版本历史记录

  • 
                Duplicate
            复制 – 创建笔记本的副本并在新的笔记本选项卡中将其打开。

  • 
                Shortcuts
            快捷方式 – 显示编写笔记本时可用的快捷方式。

打开保存的笔记本
  1. 在导航器菜单中,选择 
                    Notebooks 笔记本。此时会显示您保存的笔记本和笔记本文件夹。

  2. 选择要打开的笔记本并双击。

您可以在笔记本选项卡中显示我的笔记本由我分享的笔记本,以及分享给我的团队的笔记本。

要将笔记本从本地文件导入到我的笔记本,请选择 
            Import
        导入,然后导航到包含您的笔记本的 .ipynb 文件。笔记本会导入到当前打开的笔记本文件夹。然后您可以在笔记本编辑器中打开笔记本。

在笔记本的上下文菜单(右键单击)中,您可以执行以下操作:

  • 打开笔记本 – 在编辑器中打开笔记本。

  • 保存版本 – 保存笔记本的一个版本。

  • 版本历史记录 – 显示笔记本的版本。在版本历史记录窗口中,您可以删除和恢复版本。您还可以根据当前选定的版本创建笔记本。

  • 编辑标签 – 在笔记本上创建和编辑标签。

  • 与我的团队分享 – 与您的团队分享笔记本。

    如要与团队分享笔记本,请确保您将主体标签 sqlworkbench-team 设置为与账户中其它团队成员相同的值。例如,管理员可以为会计部门的每个人将该值设置为 accounting-team。有关示例,请参阅使用查询编辑器 v2 所需的权限

  • 导出 – 将笔记本导出到本地文件。

  • 重命名 – 重命名笔记本。

  • 复制 – 制作笔记本的副本。

  • 删除 – 删除笔记本。

要了解笔记本的演示,请观看以下视频。