Databricks 笔记本界面和控件

笔记本工具栏包括可用于管理和编辑笔记本的菜单和图标。

笔记本工具栏

笔记本名称旁边是用于更改笔记本默认语言的按钮,如果笔记本包含在 Databricks Git 文件夹中,请打开 Git 对话框

要查看笔记本以前的版本,请单击菜单右侧的“上次编辑...” 消息。

更新的单元格设计

重要

此功能目前以公共预览版提供。

更新后的单元格设计已推出。 本页包含有关如何使用这两个版本的单元格设计的信息。 有关新 UI 的介绍和常见问题解答,请参阅 新单元格 UI 介绍

若要启用或禁用新的单元格设计,请在工作区中打开编辑器设置页。 在边栏中,单击“开发人员”。 在“试验功能”下,切换“新单元格 UI”

笔记本单元格

笔记本包含两种类型的单元格集合:代码单元格和 Markdown 单元格。 代码单元格包含可运行的代码。 Markdown 单元格包含 Markdown 代码(执行单元格时会呈现为文本和图形),并可用于记录或演示代码。 可以在笔记本中添加或删除单元格来构建工作。

可以一次运行一个单元格、一组单元格或整个笔记本。 笔记本单元格最多可以包含 10MB。 笔记本单元格输出限制为 20MB。

笔记本工具栏图标和按钮

下表介绍了工具栏右侧的图标和按钮:

图标 说明
全部运行按钮中断执行按钮 运行所有单元格或停止执行。 此按钮的名称根据笔记本的状态而变化。
笔记本标头计算选择器 打开计算选择器。 当笔记本连接到群集或 SQL 仓库时,此按钮会显示计算资源的名称。
笔记本标头作业计划程序 打开作业计划程序
笔记本标头 DLT 选择器 打开增量实时表。 仅当笔记本是增量实时表管道的一部分时,才会显示此按钮。
笔记本标头共享按钮 打开权限对话框

右侧边栏操作

笔记本右侧边栏中提供了多项操作,如下表所述:

图标 说明
笔记本标头注释图标 打开笔记本注释
笔记本标头试验图标 打开 MLflow 笔记本试验
笔记本版本历史记录图标 打开笔记本版本历史记录
笔记本变量资源管理器 打开变量资源管理器。 (适用于 Databricks Runtime 12.2 LTS 及更高版本的 Python 变量。)
笔记本环境 打开 Python 环境面板。 此面板显示笔记本可用的所有 Python 库,包括笔记本范围的库、群集库和 Databricks Runtime 中包含的库。 仅当笔记本附加到群集时才可用。

浏览数据

重要

此功能目前以公共预览版提供。

若要浏览笔记本中可用的表和卷,请单击笔记本左侧的 笔记本数据图标 以打开架构浏览器。 有关更多详细信息,请参阅浏览数据

单元格操作菜单

通过单元格操作菜单,可以剪切和复制单元格、在笔记本中移动单元格以及隐藏代码或结果。 该菜单在原始 UI 和新 UI 中具有不同的外观。 本部分包括这两个版本的说明。

如果在工作区中启用了 Databricks 助手,则可以在代码单元格中使用它来获取代码的相关帮助或建议。 若要在单元格中打开 Databricks 助手文本框,请单击单元格右上角的 Databricks 助手图标 Databricks 助手图标

使用单元格右上角附近的单元格语言按钮可以将单元格在代码和 Markdown 之间轻松切换,或更改代码单元格的语言。

单元格语言按钮

单元格操作菜单(原始 UI)

单元格操作菜单

从此菜单中,还可以运行代码单元格:

单元格操作菜单 - 运行

单元格操作菜单还包括用于隐藏单元格 单元格最小化 或删除单元格 删除图标 的按钮。

Markdown 单元格有一个将单元格添加到仪表板的选项。 有关详细信息,请参阅笔记本中的仪表板

仪表板

在新 UI 中使用单元格

以下屏幕截图描述了笔记本单元格右上角显示的图标:

右上角单元格图标 - 新 UI

语言选择器:选择单元格的语言

Databricks 助手:启用或禁用用于在单元格中获取代码建议的 Databricks 助手

单元格焦点:放大单元格,使其更易于编辑

显示单元格操作菜单:打开单元格操作菜单。 对于代码单元格和 Markdown 单元格,此菜单中的选项略有不同。

“单元格操作”菜单 - 新 UI

若要在新 UI 中运行代码单元格,请单击代码单元左上角的向下箭头。

单元格运行菜单 - 新 UI

运行单元格后,单元格运行菜单右侧会显示一条通知,其中显示了单元的上次运行时间和运行持续时间。 将光标悬停在通知上以获取更多详细信息。

上次运行图像

若要将 Markdown 单元格或具有表算结果的单元格添加到仪表板,请从单元格操作菜单中选择“添加到仪表板”。 有关详细信息,请参阅笔记本中的仪表板

若要删除单元格,请单击单元格右侧的回收站图标。 只有在将光标悬停在单元格上时,才会显示此图标。

单元格回收站图标

若要向单元格中的代码添加注释,请突出显示代码。 在单元格右侧,将显示一个注释图标。 单击该图标以打开注释框。

“命令”图标

若要向上或向下移动单元格,请单击并按住单元格左上角外部的 “移动单元格”图标,然后将单元格拖动到新位置。 还可以从单元格操作菜单中选择“上移”或“下移”

创建单元格

笔记本有两种类型的单元格:代码和 Markdown。 Markdown 单元格的内容将呈现为 HTML 格式。 例如,此代码段包含一级标题的标记:

%md ### Libraries
Import the necessary libraries.

呈现效果如下所示:

已呈现的 Markdown 示例

创建单元格(原始 UI)

若要在原始 UI 中创建新单元格,请将光标悬停在顶部或底部的单元格上,然后单击 添加单元格 图标。 还可以使用笔记本单元格菜单:单击向下脱字号并选择“在上方添加单元格”或“在下方添加单元格”。

对于代码单元格,只需在单元格中键入代码。 若要创建 Markdown 单元格,请使用单元格的语言按钮选择“Markdown”,或在单元格顶部键入 %md

创建单元格(新 UI)

若要在新 UI 中创建新单元格,请将光标悬停在顶部或底部的单元格上。 单击“代码”或“文本”以分别创建代码或 Markdown 单元格

用于新建单元格的按钮

剪切、复制和粘贴单元格

有多种选项可用于剪切和复制单元格。 如果使用 Safari 浏览器,则只能使用键盘快捷方式。

  • 原始 UI新 UI 的单元格操作菜单中,选择“剪切单元格”或“复制单元格”
  • 使用键盘快捷方式:Command-XCtrl-X 用于剪切,Command-CCtrl-C 用于复制。
  • 使用笔记本顶部的“编辑”菜单。 选择“剪切”或“复制”。

剪切或复制单元格后,可将这些单元格粘贴到笔记本中的其他位置、其他笔记本中,或粘贴到其他浏览器标签页或窗口中的笔记本中。 要粘贴单元格,请使用键盘快捷方式 Command-VCtrl-V。 单元格将粘贴到当前单元格下方。

若要撤消剪切或粘贴操作,可以使用键盘快捷方式 Command-ZCtrl-Z,也可以使用菜单选项“编辑”>“撤消剪切单元格”或“编辑”>“撤消粘贴单元格”

要选择相邻的单元格,请单击 Markdown 单元格,然后使用“Shift” + “向上箭头”或“向下箭头”选择其上方或下方的单元格。 使用编辑菜单将选定的单元格作为一个组进行复制、剪切、粘贴或删除。 要选择所有单元格,请选择“编辑”>“选择所有单元格”或使用命令模式快捷方式 Cmd+A

笔记本目录

若要显示自动生成的目录,请单击笔记本左上角的图标(左侧边栏和最顶部的单元格之间)。 目录是通过笔记本中使用的 Markdown 标题生成的。 如果使用新 UI,包含标题的单元格也会显示在目录中。

打开目录

单元格显示选项

笔记本有三个显示选项。 使用“视图”菜单更改显示选项

  • 标准视图:结果紧跟在代码单元格之后显示。
  • 仅显示结果:只显示结果。
  • 并排显示:代码和结果单元格并排显示。

在新 UI 中,从单元格装订线(单元格右侧和左侧的区域)中的图标中可以获取操作。 例如,若要向上或向下移动单元格,请使用左侧装订线中的控制点 “移动单元格”图标。 若要删除单元格,请使用右装订线中的垃圾桶图标。

为便于编辑,请单击焦点模式图标 单元格焦点图标 以全宽显示单元格。 若要退出焦点模式,请单击 取消单元格焦点图标。 还可以通过关闭“视图”>“居中布局”来放大单元格的显示宽度

若要自动将笔记本中的所有单元格的格式设置为行业标准行长和间距,请选择“编辑”>“设置笔记本格式”

行号和命令号

要显示或隐藏行号或命令号,请从“视图”菜单中选择“行号”或“命令号”。 对于行号,还可以使用键盘快捷键“Control+L”。

如果启用行号或命令号,Databricks 会保存你的首选项,并在该浏览器的所有其他笔记本中显示它们。

行号和命令号(原始 UI)

单元格上方的命令号会链接到该特定命令。 如果单击某个单元格的命令号,则会更新 URL,使之定位到该命令。 要获取笔记本中特定命令的 URL 链接,请右键单击命令号,然后选择“复制链接地址”

行号和命令号(新 UI)

新 UI 中默认关闭行号。 若要开启它们,请选择“查看”>“行号”。 当单元格处于错误状态时,无论选择如何,都会显示行号。

若要切换命令编号,请选择“视图”>“命令编号”

新 UI 不包含单元格命令号链接。 若要获取笔记本中特定命令的 URL 链接,请单击 单元格焦点图标 打开焦点模式,然后从浏览器地址栏中复制 URL。 若要退出焦点模式,请单击 取消单元格焦点图标

添加单元格标题

若要使用原始 UI 向单元格添加标题,请从单元格操作菜单中选择“显示标题”

若要使用新 UI 向单元格添加标题,请执行以下操作之一:

  • 单击单元格顶部中心显示的单元格编号并键入标题。
  • 单元格操作菜单中选择“添加标题”

使用新的 UI 时,具有标题的单元格将显示在笔记本的目录中。

添加单元格标题

在深色模式下查看笔记本

你可以选择在深色模式下显示笔记本。 要启用或关闭深色模式,请选择“视图”>“主题”,然后选择“浅色主题”或“深色主题”。

隐藏和显示单元格内容

单元格内容包含单元格代码和通过运行单元格生成的结果。 可以使用单元格右上角的单元格操作菜单隐藏和显示单元格代码及结果。

有关相关功能,请参阅可折叠的标题

隐藏和显示单元格内容(原始 UI)

若要隐藏单元格代码或结果,请单击 向下箭头图标 并选择“隐藏代码”或“隐藏结果”。 还可以选择 Cell Minimize 以仅显示单元格的第一行。

若要显示隐藏的单元格代码或结果,请单击“显示”链接:

显示隐藏的代码和结果

隐藏和显示单元格内容(新 UI)

若要隐藏单元格代码或结果,请单击单元格右上角的 kebab 菜单 单元格短横线图标,然后选择“隐藏代码”或“隐藏结果”。 还可以选择“折叠单元格”以仅显示单元格的第一行。 若要展开折叠的单元格,请选择“展开单元格”

若要显示隐藏的单元格代码或结果,请单击“显示”图标:显示图标

可折叠的标题

在包含 Markdown 标题的单元格后显示的单元格可以折叠到标题单元格中。 要展开或折叠整个笔记本中包含 Markdown 标题的单元格后面的单元格,请从“视图”菜单中选择“折叠所有标题”。 本部分的其余部分介绍如何展开或折叠单元格的子集。

有关相关功能,请参阅隐藏和显示单元格内容

展开和折叠标题(原始 UI)

该图像显示了一个 2 级标题“MLflow 设置”,其中折叠了以下两个单元格

原始 UI 中的折叠单元格

若要展开和折叠标题,请单击 +-

展开和折叠标题(新 UI)

该图像显示了一个 2 级标题“MLflow 设置”,其中折叠了以下两个单元格

新 UI 中的折叠单元格

若要展开和折叠标题,请将光标悬停在 Markdown 单元格上。 单击显示在单元格左侧的箭头。

笔记本的计算资源

本部分介绍笔记本计算资源的选项。 可以在 Databricks 群集上运行笔记本,或者,对于 SQL 命令,还可以选择使用 SQL 仓库(一种针对 SQL 分析进行优化的计算类型)。

将笔记本附加到群集

若要将笔记本附加到群集,需要“可附加到群集级别”权限

重要

只要笔记本附加到群集,对笔记本具有“可运行”权限的任何用户就具有访问群集的隐式权限。

若要将笔记本附加到群集,请单击笔记本工具栏中的计算选择器,然后从下拉菜单中选择一个群集。

该菜单显示最近使用过或当前正在运行的群集选择。

附加笔记本

若要从所有可用群集中进行选择,请单击“更多...”。 单击群集名称以显示下拉菜单,然后选择现有群集。

“更多群集”对话框

还可以通过从下拉菜单中选择“新建资源...”来创建新群集

重要

附加的笔记本定义了以下 Apache Spark 变量。

变量名称
SparkContext sc
SQLContext/HiveContext sqlContext
SparkSession (Spark 2.x) spark

请勿创建 SparkSessionSparkContextSQLContext。 这样做会导致行为不一致。

将笔记本与 SQL 仓库配合使用

将笔记本附加到 SQL 仓库时,可以运行 SQL 和 Markdown 单元。 以任何其他语言(如 Python 或 R)运行单元格都会引发错误。 在 SQL 仓库上执行的 SQL 单元格会显示在 SQL 仓库的查询历史记录中。 运行查询的用户可以通过单击输出底部的运行时间从笔记本查看查询配置文件

运行笔记本需要专业版或无服务器 SQL 仓库。 你必须有权访问工作区和 SQL 仓库。

将笔记本附加到 SQL 仓库时,小组件的工作方式有所不同。 有关详细信息,请参阅在 SQL 仓库上使用 Databricks 小组件

若要将笔记本附加到 SQL 仓库,请执行以下操作:

  1. 单击笔记本工具栏中的计算选择器。 下拉菜单会显示当前正在运行的或最近使用的计算资源。 SQL 仓库带有 SQL 仓库标签

  2. 从菜单中选择一个 SQL 仓库。

    若要查看所有可用的 SQL 仓库,请从下拉菜单中选择“更多...”。 此时会出现一个对话框,其中显示了笔记本可用的计算资源。 选择“SQL 仓库”,选择要使用的仓库,然后单击“附加”。

    选择了 SQL 仓库的更多群集对话框

创建工作流或计划作业时,还可以选择 SQL 仓库作为 SQL 笔记本的计算资源。

SQL 仓库的限制包括:

  • 附加到 SQL 仓库时,执行上下文的空闲超时为 8 小时。
  • 返回的结果的最大大小为 10,000 行或 2MB,以较小者为准。

分离笔记本

若要将笔记本与计算资源分离,请单击笔记本工具栏中的计算选择器,然后将鼠标悬停在列表中已附加的群集或 SQL 仓库上,以显示边侧菜单。 在侧菜单中,选择“拆离”。

拆离笔记本

也可使用群集详细信息页上的“笔记本”选项卡将笔记本从群集中拆离。

分离笔记本时,会删除执行上下文,并会从笔记本中清除已计算出来的所有变量值。

提示

Azure Databricks 建议从群集中分离未使用的笔记本。 这将释放驱动程序占用的内存空间。

使用 Web 终端和 Databricks CLI

若要在笔记本中打开 Web 终端,请单击右侧边栏底部的 重新打开底部面板

在 Web 终端中使用 Databricks CLI

从 Databricks Runtime 15.0 开始,可以从笔记本中的 Web 终端使用 Databricks CLI。

要求

  • 笔记本必须附加到单个用户无隔离共享访问模式的群集。
  • CLI 在为专用链接启用的工作区中不可用。

已安装的 CLI 始终是最新版本。 身份验证基于当前用户。

不能从笔记本单元使用 CLI。 笔记本中的 %sh databricks ... 等命令不适用于 Databricks Runtime 15.0 或更高版本。