在 Visual Studio Code 中创建和管理 Microsoft Fabric 笔记本

适用于 Synapse 的 Visual Studio (VS) Code 扩展完全支持 Fabric 中的 CRUD(创建、读取、更新和删除)笔记本操作。 该扩展还支持本地工作区和远程工作区之间的同步。当你同步更改时,可以解决本地工作区和远程工作区之间的任何冲突或差异。

使用此扩展时,还可以在远程 Apache Spark for Fabric 计算上运行笔记本。

使用 Synapse 扩展打开 Notebook

通过在 Fabric 门户的笔记本创作页中单击“在 VS Code 中打开”按钮,可以直接使用适用于 Fabric 的 Synapse VS Code 扩展打开同一笔记本。 在 VS Code 中激活扩展并打开笔记本一次后,工作区应自动连接到笔记本。

在 VS Code 中打开笔记本。

提示

如果尚未安装适用于 VS Code 的 Synapse 扩展,必须先安装它。 有关详细信息,请参阅安装 Synapse 扩展。 公开发布扩展后,会自动安装。

查看笔记本列表

笔记本树节点列出当前工作区中的所有笔记本项。 根据 VS Code 中的更改,该列表会显示不同的颜色和字符以指示最新状态,如下图所示。

  • 默认:笔记本名称右侧的白色文本和无字符表示默认状态或已初始化状态。 笔记本存在于远程工作区中,尚未在本地下载。
  • 已修改:名称右侧的M字符和黄色文本表示已在 VS Code 中本地下载和编辑笔记本,并且尚未将挂起的更改发布回远程工作区。
  • 本地:L字符和绿色文本表示笔记本已下载,且内容与远程工作区相同。
  • 冲突:C 字符和红色文本表示本地版本与远程工作区版本之间存在冲突。

显示各个笔记本的不同状态的笔记本列表的屏幕截图。

创建笔记本

  1. 在 VS Code Explorer 中,将鼠标悬停在笔记本工具栏上。 此时会显示“创建笔记本”选项。

    VS Code 中笔记本列表的屏幕截图,显示了选择创建笔记本选项的位置。

  2. 选择“创建笔记本”并输入名称和说明。 新笔记本会在远程工作区中创建,并在笔记本列表中以默认状态显示。

下载笔记本

必须先将笔记本下载到 VS Code,然后才能编辑笔记本内容。

  1. 在 VS Code 的笔记本列表中,将鼠标悬停在笔记本名称上。 “下载”选项显示在笔记本名称旁边。

    VS Code Explorer 笔记本列表的屏幕截图,显示了选择下载笔记本选项的位置。

  2. 选择“下载”并将笔记本保存到本地工作目录。

打开笔记本

  1. 在 VS Code Explorer 中,将鼠标悬停在已下载的笔记本的名称上。 笔记本旁边会显示多个选项,包括“打开笔记本文件夹”选项。

    VS Code Explorer 的屏幕截图,显示了在哪里选择“打开笔记本文件夹”。

  2. 选择“打开笔记本文件夹”,笔记本将在 VS Code 编辑器屏幕中打开。

删除笔记本

提示

若要避免失败,请关闭 Explorer 视图中的笔记本文件夹,然后在删除笔记本之前关闭编辑器视图中的笔记本。

要删除笔记本:

  1. 在 VS Code Explorer 中,将鼠标悬停在要删除的笔记本的名称上。选项显示在名称右侧,包括“删除笔记本”选项。

    VS Code Explorer 的屏幕截图,显示了删除笔记本选项出现的位置。

  2. 选择“删除笔记本”选项。 出现提示时,选择仅删除本地副本或同时删除本地和远程工作区副本。

将本地更改发布到远程工作区

将本地更改推送到远程工作区:

  1. 在 VS Code Explorer 中,将鼠标悬停在要发布到远程工作区的笔记本的名称上。选项显示在名称右侧,包括“发布”选项。

    VS Code Explorer 的屏幕截图,显示了发布笔记本选项出现的位置。

  2. 选择“发布”。 远程工作区版本随你的本地 VS Code 的更改而更新。

    • 如果本地更新创建了任何合并冲突,则系统会提示你在合并之前解决它们。
  3. 如果其他人在 Fabric 门户中打开了同一笔记本,则会通知他们接受或拒绝本地 VS Code 更改,如下图所示。

    通知门户用户已检测到外部编辑的对话框屏幕截图。对话框包括一个“接受”和一个“拒绝”按钮。

    • 接受:你在 VS Code 中的更改已成功保存到工作区中。
    • 拒绝:你在 VS Code 中的更改已被忽略。

从远程工作区拉取更改

若要使用最新的工作区版本更新本地版本,请拉取远程版本:

  1. 在 VS Code Explorer 中,将鼠标悬停在要更新的笔记本的名称上。选项显示在名称右侧,包括“更新笔记本”选项。

    VS Code Explorer 的屏幕截图,显示了选择**更新笔记本**选项的位置。

  2. 选择“更新笔记本”选项。 VS Code 从远程工作区拉取最新版本,并打开 VS Code 差异编辑器以便比较这两个笔记本文件。 左侧屏幕来自工作区,右侧屏幕来自本地版本:

    显示更新笔记本差异的屏幕截图。

  3. 更新左侧的代码/markdown 单元格以解决此问题。

  4. 解决所有冲突后,选择差异编辑器右上角的“合并”选项以确认合并已完成。 (在选择“合并”之前,笔记本会保持“冲突”模式。)

    VS Code 差异编辑器屏幕右上角的屏幕截图,显示了选择合并选项的位置。

重要

打开差异编辑器一次后,扩展不会自动刷新差异视图的左侧以从远程工作区提取最新更新。

在远程 Spark 计算上运行或调试笔记本

通过选择此扩展附带的内核 synapse-spark-kernel,可以在远程 Spark 计算上运行代码单元。 选择此内核后,在运行时,扩展将截获所有 PySpark API 调用,并将其转换为对远程 Spark 计算的相应 http 调用。 对于纯 Python 代码,它仍在本地环境中执行。

显示运行笔记本的位置的屏幕截图。