次の方法で共有

Power Query SDK の概要

  • [アーティクル]

この記事の目的は、Power Query SDK for Visual Studio Code 内にある全体的な機能と開発エクスペリエンスの概要を説明することです。

新しいプロジェクトの作成

ヒント

拡張機能プロジェクトを作成する前に、拡張機能プロジェクトを保存する新しいフォルダーを作成することをお勧めします。 新しいプロジェクトの作成中にフォルダーが選択されていない場合、Power Query SDK は、拡張機能プロジェクトを作成する前に新しいフォルダーを検索または作成するのに役立ちます。

Visual Studio Code に入ると、Visual Studio Code のメインの エクスプローラー ペインに、Power Query SDK という名前のセクションがあります。 このセクションには、拡張プロジェクトの作成というボタンが 1 つだけあります。 このボタンを選択します。

Visual Studio Code で新しい拡張機能プロジェクト ボタンを作成します。

このボタンをクリックすると、Visual Studio Code インターフェイスの上部に入力フィールドが開きます。 新しい拡張機能プロジェクトの名前を入力し、Enter を選択します。

新しい拡張プロジェクトを作成し、プロジェクトに名前を付ける。

数秒後、Visual Studio Code ウィンドウで、コネクタ ロジックを含む拡張機能プロジェクトのメイン *.pq ファイルが開きます。 Power Query SDK は、ワークスペースの設定を完了するため、いくつかの必要なタスクを自動的に実行します。 これらのタスクは、Visual Studio Code の出力コンソールで確認できます。

Hello World テンプレートを使用して作成された拡張機能プロジェクト。

Power Query SDK は、次のファイルのセットを自動的に作成します。

  • ワークスペース レベルで使用する特定の設定を指示する settings.json ファイル。
  • 拡張機能を .mez ファイルとして構築し、新しい bin\AnyCPU\Debug フォルダーに保存します。
  • .png ファイルとしてのコネクタ アイコンのセット。
  • resources.resx ファイル。拡張機能で使用される文字列のメイン ストレージとして機能します。
  • 拡張機能またはコネクタのメイン ロジックを保持する .pq ファイル。
  • .query.pq ファイルの主な目的は、後で評価できるテスト クエリを作成する方法として使用することです。
  • 拡張プロジェクトに関する情報を保持する .proj ファイル。

コネクタ ファイルの一覧。

拡張機能プロジェクトが Visual Studio Code によって認識されると、Power Query SDK のセクションの外観が変わり、新しい拡張機能プロジェクトに対して実行できるタスクのリストが表示されます。

Power Query SDK セクション内のタスク。

資格情報

重要

データ コネクタのクエリを評価する前に、まず拡張プロジェクト用の資格情報のセットを作成する必要があります。

Power Query SDK は、ユーザー インターフェイスを通じて、拡張機能プロジェクトから資格情報を設定、一覧表示、および削除できる複数のタスクを提供します。

資格情報の設定

Power Query SDK は主に、複数のエントリ ポイントを通じてトリガーできるタスクによって駆動されます。 資格情報の設定は 2 つの方法で実行できます (他の資格情報タスクも同じ方法で実行できます)。

  • エクスプローラー ウィンドウの [Power Query SDK] セクションのエントリから。

    エクスプローラーの Power Query SDK セクションから資格情報を設定します。

  • ターミナル 経由で、タスクの実行 オプションを選択し、資格情報の設定 タスクを選択します。

    ターミナル メニューを使用して資格情報を設定します。

このタスクを実行すると、Visual Studio Code の一連のプロンプトが表示され、資格情報を設定できるようになります。 これらの一連のプロンプトは予測可能であり、常に同じ段階で構成されます。

  1. データソースの種類を選択します。
  2. コネクタ ファイルを選択します。
  3. 認証方法を選択します。

既存の拡張プロジェクトの場合、利用可能な認証方法は匿名です。 認証が設定されると、資格情報が正常に生成されたことを確認するメッセージがウィンドウの右下隅に表示されます。

資格情報が正常に生成されました。

資格情報をリストする

資格情報の設定と同様に、資格情報をリストするタスクには、エクスプローラーペインのPower Query SDKセクションとターミナルメニュー内の2つのエントリーポイントがあります。

このタスクが実行されると、出力ターミナル内で使用可能な資格情報が表示されます。

出力コンソール内に一覧表示される資格情報。

すべての認証情報をクリアする

前の2つのタスクと同様に、すべてのクレデンシャルをクリアするタスクは同じ場所に2つのエントリーポイントがあります： Explorer ペインの Power Query SDK セクションと Terminal メニューの中です。

このタスクは、クエリを評価するために新しい資格情報を設定する必要がある場合に、現在のセッションからすべての資格情報をクリアする方法として機能します。

このタスクの情報メッセージも出力コンソールに表示されます。

[すべてクリア] 資格情報タスクの情報メッセージ。

クエリと結果パネルを評価する

テスト クエリを評価する前に、資格情報を設定する必要があります。 前のセクションで作成したコネクタを使用して、テスト クエリ ファイルとして機能する *.query.pq ファイルを開くことができます。

プロジェクト名が MyConnector であるこの特定のコネクタのコードは次のようになります。

// Use this file to write queries to test your data connector
let
    result = MyConnector.Contents()
in
    result

クエリを評価する前に、コードを次のように変更しましょう。

// Use this file to write queries to test your data connector
let
    result = MyConnector.Contents("Hello World")
in
    result

コードを変更した後は、必ずファイルを保存してください。

このクエリを評価するには、次の 3 つのオプションがあります。

  • 使用中のファイルを右選択し、[現在の電源クエリ ファイルを評価する] オプションを選択します。

現在のファイルを右クリックして評価します。

  • ターミナル メニューに移動し、現在のファイルの評価 タスクを選択します。

ターミナル メニュー エクスペリエンスから現在のファイルの評価タスクを選択します。

  • Visual Studio Code のネイティブの [実行とデバッグ] オプションを使用し、ハイパーリンクを選択して launch.json ファイルを作成し、ファイルを評価します。

実行およびデバッグ機能拡張を使用してクエリを評価するlaunch.json ファイルを作成します。

クエリを評価した後、結果はウィンドウの下部にあるコンソールと、右側の result パネルと呼ばれる新しいパネルに表示されます。

評価後の Visual Studio Code ウィンドウが終了すると、コンソールと結果パネルに出力が表示されます。

結果パネルには 3 つのタブが含まれています。

  • [出力] タブ: 評価されたクエリのデータ プレビューが表示されます。 データがテーブルの場合は、グリッドとして表示されます。

    結果パネルの [出力] タブ。

  • 概要: 評価を実行したアクティビティの概要と、そのアクティビティに関連付けられた統計が表示されます。

    結果パネルの [概要] タブ。

  • DataSource: 評価に使用されたデータ ソースに関する一般情報が表示されます。

    結果パネルの [データソース] タブ。

別のクエリを評価するには、*.query.pq ファイルを変更して保存し、3 つの方法のいずれかを使用して評価タスクを再度実行します。

Note

Power Query SDK は、評価用のキャッシュ メカニズムを一切管理しません。

従来の拡張機能プロジェクトを新しい SDK に取り込む

このセクションは、従来の Visual Studio ベースの Power Query SDK で作成された拡張プロジェクトを持つコネクタ開発者に役立ちます。

手順に従って、TripPin サンプルの DataConnectors リポジトリから入手可能なコネクタ プロジェクト、特にサンプル 9-TestConnection をダウンロードすることをお勧めします。

従来の拡張機能プロジェクトを新しい SDK に取り込むには、次の手順に従います。

  1. Visual Studio Code で、[ファイル>フォルダーを開く] を選択し、拡張機能プロジェクトが存在するフォルダーに移動します。

  2. 次の 2 つの方法のいずれかを使用して、既存のフォルダーとその内容を使用してワークスペースをセットアップします。

    • Power Query SDK にはフォルダーの内容を認識するメカニズムがあり、新しい Power Query SDK ワークスペースへの変換を有効にすることを提案します。

      Power Query SDK ワークスペースへのアップグレードをユーザーに提案する Visual Studio Code インターフェイスのポップアップ。

    • ターミナル メニューから セットアップ ワークスペース と ビルド タスク を実行します。 これらにより、ワークスペースに必要な .mez ファイルと settings.json ファイルが効果的に作成されます。

2 つの新しいフォルダーとファイルを追加すると、現在のワークスペースが新しい Power Query SDK ワークスペースに変換されます。

拡張機能プロジェクトを新しい Power Query SDK にアップグレードする。

ワークスペースを設定する

ワークスペース設定タスクは、評価と一般設定に関してワークスペースで使用されるいくつかの変数を指定するワークスペース用の settings.json ファイルを効率的に作成します。

拡張ファイルをビルドする

ビルド タスクを使用すると、オンデマンドで拡張機能の .mez ファイルを作成できます。

TestConnection関数を実行する

TestConnection は、Power BI などのサービスを通じて Microsoft Cloud でコネクタを更新できるようにする機能です。 これは、コネクタ データ ソース レコード内に実装されたレコードです。 TestConnection ハンドラーの実装の詳細については、テスト接続で利用可能なサンプルをご覧ください。

TestConnection を実行するタスクを使用すると、Microsoft Cloud でこのハンドラーを手動で試行しなくても、Power Query SDK 内でハンドラーをテストできます。

このタスクを実行するには、まずコネクタの資格情報を設定し、エクスプローラー の Power Query SDK セクションから、またはターミナル メニュー内のタスクのリストからタスクを実行します。

このタスクの結果は、ウィンドウの下部にある出力端子に表示されます。

Power Query SDK での TestConnection の実行関数の結果。

フィードバックとバグ

カスタム コネクタの開発に関するヘルプが必要な場合、または報告したいフィードバック、提案、バグがある場合は、GitHub の非公式のパブリック リポジトリをご覧ください。

Power BI コミュニティ フォーラム を使用して、Power Query、M 言語、カスタム コネクタ開発に関する一般的な質問を投稿することもできます。