使用 Power Query SDK 開發連接器
Power Query SDK 是一組旨在協助您建立 Power Query 連接器的工具。 這些連接器通常稱為自定義連接器或 Power Query 延伸模組。
自定義連接器可讓您建立新的數據源,或自定義和擴充現有的來源。 常見使用案例包括:
- 為 REST API 建立商務分析師友好的檢視。
- 為 Power Query 支援的來源提供商標與現有的連接器(例如 OData 服務或 ODBC 驅動程式)。
- 實作 SaaS 供應專案的 OAuth v2 驗證流程。
- 公開數據源的有限或篩選檢視,以改善可用性。
- 使用 ODBC 驅動程式為數據源啟用 DirectQuery。
從 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 提供基本的查詢執行功能,可讓您測試延伸模組,而不需要切換至不同的用戶端應用程式。 您可以在應用程式中進一步測試連接器,例如:
除了擴充檔案之外,Data Connector 專案還可以有查詢檔 (name.query.pq)。 此檔案可用來在 Visual Studio Code 中執行測試查詢。 查詢評估會自動包含您的延伸模組程序代碼,而不需要註冊 your.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自定義連接器
建立連接器之後,您可以視需要傳送此檔案給使用者,而且他們可以在適用的產品體驗中使用連接器,例如Microsoft Power BI。
您可以在 Microsoft Power BI Desktop 中使用自己的自定義連接器,以及適用於語意模型的 Microsoft Power BI 服務,以在雲端中重新整理和連線。
Power Query 連接器可以載入三種體驗:
- 內部部署數據閘道:連接器可以透過閘道載入,以用於 Microsoft Fabric 和 Microsoft Power BI 服務
- Power Query Online:在 Power BI Datamarts、Fabric 數據流 Gen2 等體驗中,以及其他許多專案
- Power Query Desktop:在 Power BI Desktop 等體驗內。
您可以使用下列文章,深入瞭解如何使用自訂連接器進行自我散發:
Data Factory 連接器認證計劃可讓您將連接器提交至Microsoft進行認證,其中Microsoft負責在 Microsoft Fabric 和 Microsoft Power BI 中發佈和散發連接器,以取得適用的產品和體驗:
- Power Query Desktop:Microsoft Power BI Desktop。
- Power Query Online:Microsoft Fabric 數據流 Gen2、Microsoft網狀架構倉儲、Microsoft Power BI Datamarts、Microsoft Power BI 數據流 Gen1 及其他
- 內部部署數據閘道:針對使用閘道進行驗證重新整理或連線的 Microsoft Fabric 和 Microsoft Power BI。
深入瞭解 Data Factory 連接器認證計劃。