共用方式為


使用 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 MarketplaceVisual Studio Code 區段安裝 Visual Studio Code Power Query SDK。 選取 [ 安裝] 以安裝 SDK。

連線 or 開發程式

下列各節說明使用 SDK 建立 Power Query 連接器最常見的程式。

建立新的擴充功能

建立新的工作區 (Visual Studio Code Power Query SDK) 時,您會從下列核心檔案開始:

  • 連線 or 定義檔 (<connectorName.pq>)
  • 查詢檔案 (<connectorName.query.pq>)
  • 字串資源檔案 (resources.resx)
  • 用來建立圖示的各種大小的 PNG 檔案

您的連接器定義檔案會從空的數據源描述開始。 您可以從處理數據存取的文章,深入瞭解 Power Query SDK 內容中的數據源。

測試

Power Query SDK 提供基本的查詢執行功能,可讓您測試延伸模組,而不需要切換至 Power BI Desktop。

查詢測試檔案

除了延伸模組檔案之外,數據 連線 or 專案也可以有查詢檔 (name.query.pq)。 此檔案可用來在 Visual Studio Code 中執行測試查詢。 查詢評估會自動包含您的延伸模組程序代碼,而不需要註冊 your.pqx 檔案,讓您呼叫或測試延伸模組程式代碼中的任何共用函式。

查詢檔案可以包含單一表達式(例如 HelloWorld.Contents(),)、 let 表達式(例如 Power Query 會產生什麼),或區段檔。

建置和部署

建置您的項目會產生 .mez 檔案或擴展名檔案。

Power Query 延伸模組會組合在 ZIP 檔案中,並提供 .mez 擴展名。 在運行時間,Power BI Desktop 會從 [Documents]\Microsoft Power BI Desktop\Custom 連線 ors 載入擴充功能。

注意

數據 連線 or 專案不支援自定義建置後步驟,將延伸模塊檔案複製到 [Documents]\Microsoft Power BI Desktop\Custom 連線 ors 目錄。 如果這是您想要執行的動作,您可能會想要使用第三方擴充功能。

延伸模組定義於 M 區段檔內。 區段檔的格式與 Power Query 中產生的查詢檔稍有不同。 您從 Power Query 匯入的程式碼通常需要修改以符合區段檔,但變更是次要的。 您應該注意的章節檔案差異包括:

  • 它們以區段宣告開頭(例如, section HelloWorld;)。
  • 每個表達式的結尾都是分號(例如 a = 1;b = let c = 1 + 2 in c;)。
  • 所有函式和變數都是區段檔的本機,除非它們標示為共用。 共用函式會變成其他查詢/函式可見,並可視為延伸模塊的匯出(也就是說,它們可從 Power Query 呼叫)。

如需 M 區段檔的詳細資訊,請參閱 M 語言規格

數據連接器的散發

Power Query 連接器可用於 Power BI Desktop 或 Power Query Online 體驗,例如 Power BI 數據流、Power BI 數據超市和其他體驗。

Power BI Desktop

Power BI Desktop 使用者可以遵循下列步驟來取用 Power Query 自定義連接器:

  1. 將擴展名檔案 (.mez or.pqx) 複製到 [Documents]/Power BI Desktop/Custom 連線 ors。
  2. 在 Power BI Desktop 中,選取 [不允許] [允許載入任何延伸模組但不驗證] 或 [警告] 選項 [檔案>選項] 和 [>選項安全性數據延伸模組] 下的 [選項>] 或 [警告>] 選項。
  3. 重新啟動Power BI Desktop。

Power BI Desktop 會在重新啟動時自動載入擴充功能。

或者,身為數據源和連接器的擁有者,您可以將連接器提交至 Power Query 連線 or 認證計劃,以便在每個版本上隨附 Power BI Desktop。

Power Query Online

Power Query Online 體驗中只會顯示 Power Query 認證連接器。 若要深入瞭解 Power Query 連接器認證計劃,請移至 Power Query 連線 or 認證