通过

使用 Power Query SDK 开发连接器

  • 项目

Power Query SDK 是一组旨在帮助你创建 Power Query 连接器的工具。 这些连接器通常称为自定义连接器或 Power Query 扩展。

使用自定义连接器，你可以创建新数据源或自定义和扩展现有源。 常见用例包括：

  • 为 REST API 创建业务分析师易用视图。
  • 为 Power Query 通过现有连接器（例如 OData 服务或 ODBC 驱动程序）支持的源提供品牌。
  • 对 SaaS 产品/服务实施 OAuth v2 身份验证流程。
  • 显示数据源的有限视图或筛选视图以提高可用性。
  • 使用 ODBC 驱动程序为数据源启用 DirectQuery。

安装 Power Query SDK

从 Visual Studio Marketplace 的 Visual Studio Code 部分安装 Visual Studio Code Power Query SDK。 选择安装以安装此 SDK。

连接器开发流程

以下部分简要介绍使用 SDK 创建 Power Query 连接器的最常见过程。

创建一个新扩展

创建新工作区 (Visual Studio Code Power Query SDK) 时，首先使用以下核心文件：

  • 连接器定义文件 (<connectorName>.pq)
  • 查询文件 (<connectorName>.query.pq)
  • 字符串资源文件 (resources.resx)
  • 用于创建图标的各种大小的 PNG 文件

连接器定义文件以空的数据源描述开始。 可以从有关处理数据访问的文章中详细了解 Power Query SDK 上下文中的数据源。

测试

Power Query SDK 提供了基本查询执行功能，允许你测试扩展而无需切换到其他客户端应用程序。 可在应用程序中进一步测试连接器，例如：

查询测试文件

除了具有扩展文件之外，数据连接器项目还可以具有查询文件 (name.query.pq)。 此文件可用于在 Visual Studio Code 内运行测试查询。 查询评估将自动包含你的扩展代码，而不必注册 .pqx 文件，从而允许你调用或测试扩展代码中的任何共享函数。

此查询文件可以包含单个表达式（例如 HelloWorld.Contents()）、let 表达式（如 Power Query 将生成的内容）或节文档。

构建和部署

生成项目会生成 .mez 文件或扩展名文件。 Power Query 扩展捆绑在 ZIP 文件中，并被提供 .mez 文件扩展名。

扩展在 M 节文档中定义。 节文档的格式与 Power Query 中生成的查询文档的格式略有不同。 你从 Power Query 导入的代码通常需要修改以适应节文档，但更改很小。 应注意的节文档差异包括：

  • 它们以节声明（例如 section HelloWorld;）开头。
  • 每个表达式都以分号（例如，a = 1; 或 b = let c = 1 + 2 in c;）结尾。
  • 所有函数和变量除非被标记为共享，否则它们都是节文档的局部变量。 共享函数对其他查询/函数可见，可以被视为扩展的导出（即，可从 Power Query 中调用它们）。

可以在 M 语言规范中找到关于 M 节文档的详细信息。

Power Query 连接器的分配

可以通过两种途径分配连接器：

  • 自行分配
  • 连接器认证

自行分配

一种自助服务机制，可在适用的产品体验中应用 Power Query 自定义连接器

创建连接器后，可根据需要将此文件发送给用户，并且他们可以在适用的产品体验（如 Microsoft Power BI）中使用该连接器。

Microsoft Power BI

可以在 Microsoft Power BI Desktop 和 Microsoft Power BI 服务中使用自己的自定义连接器来获取语义模型，以便在云中进行刷新和连接。

Power Query 连接器可加载到三种体验中：

  • 本地数据网关：可通过网关加载连接器，以便在 Microsoft Fabric 和 Microsoft Power BI 服务中使用
  • Power Query Online：在 Power BI 数据市场、Fabric Dataflow Gen2 等体验中
  • Power Query Desktop：在 Power BI Desktop 等体验中。

可使用以下文章详细了解如何使用自定义连接器进行自行分配：

连接器认证

通过数据工厂连接器认证计划，可将连接器提交给 Microsoft 进行认证，Microsoft 负责在 Microsoft Fabric 和 Microsoft Power BI 中发布和分配连接器，以获取适用的产品和体验：

  • Power Query Desktop：Microsoft Power BI Desktop。
  • Power Query Online：Microsoft Fabric Dataflow Gen2、Microsoft Fabric 仓库、Microsoft Power BI 数据市场、Microsoft Power BI Dataflow Gen1 等
  • 本地数据网关：适用于使用网关进行经过身份验证的刷新或连接的 Microsoft Fabric 和 Microsoft Power BI。

详细了解数据工厂连接器认证计划。