文档

Notebook概述

更新时间:

Dataphin Notebook是基于Web的交互式计算环境,支持您以笔记本的形式编写SQL代码与Markdown文本相结合的富媒体内容,并且可以运行其中的SQL代码并实时显示结果。

应用场景

记录分析过程:您可以使用Dataphin Notebook记录您的分析思路与过程,包括代码、运行结果与分析结论等。可形成完整的数据分析报告,方便您进行分析过程与结果回顾,也可分享给其他Dataphin实例的用户查看。

便捷地查询数据:您可以在Dataphin Notebook中便捷地进行数据查询与分析。可快速切换运行项目。如您不在任何项目中,您也可以使用已绑定的分析平台专用计算源进行数据查询与分析。

功能介绍

Dataphin Notebook的主要功能特点包括:

  • 交互式编程环境:您可以直接在Dataphin Notebook中编写SQL代码,可以运行查看并保留每次的运行结果。

  • 支持多种单元组件:您可以在Dataphin Notebook中添加Markdown单元组件,以支持编写文本内容;添加SQL单元、数据库SQL单元组件,以支持编写SQL代码查询数据。

Notebook开发页面概述

Notebook开发页面主要由Notebook目录、我的数据表、编辑器菜单、编辑区、大纲组成您可以在Notebook开发页面进行Notebook管理。

image.png

区域

描述

Notebook目录

Notebook目录中存在2个根目录。我的分享给我目录。

  • 我的:您创建的Notebook将归类于该根目录下,目录下可创建多个子目录。您可在该目录管理您创建的Notebook。新建Notebook,请参见新建Notebook

  • 分享给我:他人与您分享的Notebook将归类于该根目录下,您可在该目录查看他人分享给您的Notebook。

对于当前账号创建的Notebook任务支持重命名、移动和删除操作。

Notebook编辑器菜单

您可通过Notebook编辑器菜单对您的Notebook进行编辑管理。包括添加编辑单元(Markdown单元、SQL代码单元、数据库SQL单元)、保存、运行当前、运行全部、分享、参数配置、收起全部代码单元、展开全部代码单元、刷新、定位、项目切换。

  • 保存:单击image..png可保存当前编辑内容。

  • 运行当前:选中SQL代码单元后,您可单击image..png运行选中的SQL代码单元或使用(Cmd+Enter/Ctrl+Enter)快捷键运行。

  • 添加单元:添加单元到Notebook。目前支持Markdown单元SQL代码单元、数据库SQL单元。更多信息,请参见管理Notebook单元

  • 运行全部:单击image..png可运行当前Notebook中所有的SQL代码单元。

  • 分享:可分享当前Notebook给Dataphin实例内的其他用户。

  • 参数配置:单击image.png可在参数配置对话框中配置Notebook中参数的参数值。更多信息,请参见参数配置

  • 收起全部代码单元:单击image..png可收起当前Notebook内全部代码单元的代码

  • 展开全部代码单元:单击image..png可展开当前Notebook内全部代码单元的代码

  • 刷新:单击image..png可刷新当前Notebook内容。

  • 定位:单击image..png可在Notebook目录中定位当前Notebook。

  • 项目切换:在目录切换下拉框中,您可切换Notebook的运行项目(包括分析平台计算源)。

    说明
    • 所选运行项目的计算引擎的AccessKey需要有查询的表所在项目的访问权限,否则将会导致查询失败。

    • 若您的分析平台没有绑定默认计算源,您可为分析平台绑定专用计算源(仅支持超级管理员或系统管理员绑定专用计算源)。具体操作,请参见分析平台设置

    • 仅支持切换到当前账号所在的dev或basic项目,且该项目已绑定离线引擎。此外,账号需要具备该项目的即席查询执行权限。更多信息,请参见申请、续期和交还表权限

③编辑区

添加编辑单元到编辑器后,您可在编辑器中编写单元内容或对单元进行管理。更多信息,请参见管理Notebook单元

大纲

系统将自动为您生成按照Markdown单元中的标题层级生成的大纲。单击大纲标题支持跳转对应单元。