Power Query SDK を使用してコネクタを開発する
Power Query SDK は、Power Query コネクタの作成に役立つ一連のツールです。 これらのコネクタは、多くの場合、カスタム コネクタまたは Power Query 拡張機能と呼ばれます。
カスタム コネクタを使用すると、新しいデータ ソースを作成したり、既存のソースをカスタマイズして拡張したりできます。 一般的な使用用途は次のとおりです。
- REST API のビジネス アナリストのフレンドリ ビューを作成する
- 既存のコネクタ (OData サービスや ODBC ドライバーなど) で Power Query がサポートするソースのブランドを提供する
- 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 ファイルを登録しなくても、拡張コードが自動的に含まれるため、拡張コード内の共有関数の呼び出しやテストが可能になります。
クエリ ファイルには、1 つの式 (例: 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 コネクタの配布
コネクタを配布できる方法には、次の 2 つがあります。
- セルフディストリビューション
- コネクタ認定
セルフディストリビューション
該当する製品環境に Power Query カスタム コネクタを適用できるセルフサービス メカニズム
コネクタを作成したら、必要に応じてユーザーにこのファイルを送信し、Microsoft Power BI などの該当する製品環境でコネクタを使用できます。
Microsoft Power BI
クラウドでの更新と接続には、Microsoft Power BI Desktop や Microsoft Power BI サービスのセマンティック モデルで独自のカスタム コネクタを使用できます。
Power Query コネクタは、次の 3 つの環境に読み込むことができます。
- オンプレミス データ ゲートウェイ: コネクタは、Microsoft Fabric および Microsoft Power BI サービス で使用するゲートウェイを介して読み込むことができます
- Power Query Online: Power BI データマート、Fabric Dataflow Gen2 などの環境内
- Power Query Desktop: Power BI Desktop などの環境内。
セルフディストリビューションにカスタム コネクタを使用する方法の詳細については、次の記事を参照してください。
コネクタ認定
Data Factory コネクタ認定プログラムでは、コネクタをマイクロソフトに提出して認定を受けることができます。ここでは、マイクロソフトが該当する製品と環境について Microsoft Fabric と Microsoft Power BI 両方のコネクタの公開と配布を行っています。
- Power Query Desktop: Microsoft Power BI Desktop。
- Power Query Online: Microsoft Fabric Dataflow Gen2、Microsoft Fabric Warehouse、Microsoft Power BI Datamarts、Microsoft Power BI Dataflow Gen1 など
- オンプレミス データ ゲートウェイ: 認証された更新または接続にゲートウェイを使用する Microsoft Fabric と Microsoft Power BI の両方。
詳細については、「Data Factory コネクタ認定プログラム」を参照してください。