一、概述
Notebook IDE 提供与 Jupyter Notebook 类似的开发体验:
·默认单元格语言为 Python;通过魔法命令切换 SQL、Markdown 等语法。
·单元格支持新建、上移、下移、删除、隐藏运行结果等操作。
·支持多人协作:支持多人编辑场景下的提示功能,可查看当前文件的编辑人列表。
·文件支持手动保存与版本管理,最多保留 200 个保存版本。
二、前提条件
·已加入工作空间,且对当前 Notebook 文件具备「编辑」或「管理」权限。
·已创建或拥有可访问的 Notebook 文件。
三、步骤 1:打开或新建 Notebook 文件
1. 在 Studio 左侧 开发目录 中:
·单击已有的 .ipynb 文件直接打开。
·或单击 + 新建 > Notebook ,输入文件名并选择父文件夹后单击 确定 。
2. 文件以 Tab 形式打开在右侧编辑器。
四、步骤 2:管理单元格
操作栏 + 代码/文本 支持新增单元格,类型包括:
| 类型 | 说明 |
| 代码 | 默认为 Python 语法类型,支持用户切换为 SQL 语法。 |
| 文本 | 用于撰写说明文字,支持完整 Markdown 语法。 |
每个单元格支持进行如下快捷操作:
| 操作 | 说明 |
| 执行单元格 | 支持执行当前单元格、执行上方所有的单元格、执行当前单元格及以下。 |
| 上移 / 下移 | 调整单元格顺序。 |
| 隐藏结果 | 折叠单元格运行结果展示区域。 |
| 删除 | 删除当前单元格。 |
五、步骤 3:通过魔法命令切换语法
在 Python 单元格首行使用魔法命令切换该单元格的语言:
| 魔法命令 | 切换后的语法 |
| %sql | Spark SQL |
| %md | Markdown |
| %scala | Scala |
%sqlSELECT * FROM your_catalog.your_schema.your_table LIMIT 10;
注意:说明:
注意:魔法命令只对当前单元格生效;切换语法后,该单元格的代码将被对应解释器执行。
六、步骤 4:使用代码补全与语法检测
·自动补全 :输入数据库、表、视图、字段、函数名时,编辑器会基于已绑定的数据目录给出补全建议;输入 Python 库名(如 pandas、numpy)也会展示常用 API。
·语法检测 :单元格在编辑过程中会高亮 Python 语法错误、缩进错误、未定义变量等问题,并在出错行左侧显示红色波浪线。
·括号匹配 :自动配对 ()、[]、{}、单引号、双引号。
七、步骤 5:保存与查看版本
·自动缓存 :离开编辑器或定时触发自动保存。再次打开文件时自动恢复最新草稿。
·手动保存 :单击操作栏 保存 或使用快捷键 ⌘ + S,生成一条版本记录。
·查看版本 :在右侧 版本管理 抽屉中查看历史版本,每个版本展示版本号、保存人、保存时间、描述。
·版本对比、回滚 :选择两个版本进行差异对比,或选择历史版本执行回滚。
注意:说明:
注意:最多保留 200 个手动版本;超出后从最早的版本开始覆盖。
八、步骤 6:多人协同
·用户 A 打开文件进入编辑状态时,如果其他用户 B 正在编辑同一个 Cell,则会在 Cell 右上角显示当前编辑人列表,从而对用户进行提示,降低文件内容互相覆盖的风险。
九、Notebook 快捷键(Mac 键位)
| 快捷键 | 操作 |
| Y | 切换为 Code Cell |
| M | 切换为 Markdown Cell |
| D, D | 删除当前 Cell |
| ⌘ + Enter | 运行当前 Cell |
| ⇧ + Enter | 运行当前 Cell 并选中下一个 |
Windows 用户请将 ⌘ 替换为 Ctrl,⇧ 替换为 Shift。
十、支持版本管理的文件类型
.ipynb / .py / .sql / .r / .scala / .sh / .json / .yaml / .yml / .md / .txt / .csv
十一、使用限制
·单文件最多保留 200 个手动版本,自动缓存内容不计入版本。
·%sql 等非 Python 魔法命令的具体支持范围依赖底层引擎,详见 辅助工具(DLCUtils、魔法命令)。
十二、相关文档
·Notebook 运行
·辅助工具(DLCUtils、魔法命令)
·文件权限