Power Query SDK Übersicht

Der Zweck dieses Artikels besteht darin, Ihnen einen Überblick über die allgemeinen Funktionen und Entwicklungserfahrungen im Power Query SDK für Visual Studio Code zu geben.

Erstellen eines neuen Projekts

Tipp

Bevor Sie ein Erweiterungsprojekt erstellen, empfehlen wir Ihnen, einen neuen Ordner anzulegen, in dem Sie Ihr Erweiterungsprojekt speichern werden. Wenn bei der Erstellung eines neuen Projekts kein Ordner ausgewählt wird, hilft Ihnen das Power Query SDK, einen neuen Ordner zu finden oder zu erstellen, bevor Sie Ihr Erweiterungsprojekt erstellen.

Wenn Sie sich in Visual Studio Code befinden, finden Sie im Hauptfenster Explorer einen Abschnitt mit dem Namen Power Query SDK. In diesem Abschnitt gibt es nur eine Schaltfläche mit der Bezeichnung Ein Erweiterungsprojekt erstellen. Wählen Sie diese Schaltfläche aus.

Diese Schaltfläche öffnet ein Eingabefeld am oberen Rand der Visual Studio Code-Oberfläche. Geben Sie den Namen Ihres neuen Erweiterungsprojekts ein, und wählen Sie dann Enter.

Nach ein paar Sekunden öffnet Ihr Visual Studio Code-Fenster die *.pq-Hauptdatei für Ihr Erweiterungsprojekt, die Ihre Connectorlogik enthält. Das Power Query SDK führt automatisch einige notwendige Aufgaben aus, um die Einrichtung Ihres Workspaces abzuschließen. Sie können diese Aufgaben in der Ausgabekonsole von Visual Studio Code überprüfen.

Das Power Query SDK erstellt automatisch die folgende Gruppe von Dateien:

• Eine settings.json Datei, die bestimmte Einstellungen vorgibt, mit denen Sie auf Ihrer Workspacesebene arbeiten.
• Erstellt die Erweiterung als .mez-Datei und speichert sie in einem neuen bin\AnyCPU\Debug Ordner.
• Ein Satz von Verbindungssymbolen als.png-Dateien.
• Eine resources.resx Datei, die als Hauptspeicher für Zeichenfolgen dient, die in der Erweiterung verwendet werden.
• Eine.pq-Datei, die die Hauptlogik Ihrer Erweiterung oder Ihres Connectors enthält.
• Eine.query.pq-Datei, deren Hauptzweck es ist, Testabfragen zu erstellen, die Sie später auswerten können.
• Eine.proj-Datei, die Informationen über das Erweiterungsprojekt enthält.

Sobald ein Erweiterungsprojekt von Visual Studio Code erkannt wird, ändert der Abschnitt für das Power Query SDK sein Erscheinungsbild und zeigt nun eine Liste von Aufgaben an, die Sie für Ihr neues Erweiterungsprojekt ausführen können.

Anmeldeinformationen

Wichtig

Bevor Sie eine der Abfragen Ihres Datenconnectors auswerten können, muss zunächst ein Satz von Anmeldeinformationen für das Erweiterungsprojekt erstellt werden.

Das Power Query SDK bietet über seine Benutzeroberfläche mehrere Aufgaben an, mit denen Sie Anmeldeinformationen für Ihr Erweiterungsprojekt festlegen, auflisten und löschen können.

Berechtigungsnachweis festlegen

Das Power Query SDK wird in erster Linie durch Aufgaben gesteuert, die über mehrere Einstiegspunkte ausgelöst werden können. Das Einrichten eines Berechtigungsnachweises kann auf zwei Arten erfolgen (die anderen Aufgaben des Berechtigungsnachweises können auf dieselbe Weise erledigt werden).

• Über den Eintrag im Abschnitt Power Query SDK im Explorer-Fenster.

  

• Über das Terminal, indem Sie die Option Run Task und dann die Aufgabe Set credential auswählen.

  

Wenn Sie diese Aufgabe ausführen, werden Sie von Visual Studio Code durch eine Reihe von Eingabeaufforderungen geführt, damit Sie die Anmeldeinformationen festlegen können. Diese Aufforderungsreihen sind vorhersehbar und bestehen immer aus den gleichen Phasen:

1. Wählen Sie die Datenquellenart.
2. Wählen Sie die Verbindungsdatei.
3. Wählen Sie die Authentifizierungsmethode aus.

Für das bestehende Erweiterungsprojekt ist die Authentifizierungsmethode anonym verfügbar. Sobald die Authentifizierung erfolgt ist, wird in der rechten unteren Ecke des Fensters eine Meldung angezeigt, die bestätigt, dass ein Berechtigungsnachweis erfolgreich erstellt wurde.

Anmeldeinformationen auflisten

Ähnlich wie beim Einrichten eines Berechtigungsnachweises gibt es für die Aufgabe, Berechtigungsnachweise aufzulisten, zwei Einstiegspunkte an denselben Stellen: den Abschnitt Power Query SDK im Fenster Explorer und im Menü Terminal.

Wenn diese Aufgabe ausgeführt wird, zeigt sie die verfügbaren Anmeldeinformationen im Ausgabeterminal an.

ALLE Berechtigungsnachweise löschen

Ähnlich wie die beiden vorangegangenen Aufgaben hat die Aufgabe zum Löschen aller Anmeldeinformationen zwei Einstiegspunkte an denselben Stellen: den Abschnitt Power Query SDK im Fenster Explorer und im Menü Terminal.

Diese Aufgabe dient dazu, alle Anmeldeinformationen aus der aktuellen Sitzung zu löschen, wenn Sie eine neue Anmeldeinformation zur Auswertung Ihrer Abfragen festlegen müssen.

Die Informationsmeldungen zu dieser Aufgabe werden auch in der Ausgabekonsole angezeigt.

Auswertung einer Abfrage und des Ergebnispanels

Bevor Sie eine Testabfrage auswerten können, muss ein Berechtigungsnachweis erstellt werden. Mit dem im vorigen Abschnitt erstellten Connector können Sie die Datei *.query.pq öffnen, die als Ihre Testabfragedatei dient.

Für diesen speziellen Connector mit dem Projektnamen MyConnector sieht der Code wie folgt aus:

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

Bevor wir die Abfrage auswerten, müssen wir den Code wie folgt ändern:

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

Stellen Sie sicher, dass Sie die Datei nach der Änderung des Codes speichern.

Um diese Abfrage auszuwerten, haben Sie drei Möglichkeiten:

• Wählen Sie die verwendete Datei mit der rechten Maustaste aus und wählen Sie die Option Evaluate current power query file.

• Rufen Sie das Menü Terminal auf und wählen Sie die Aufgabe Aktuelle Datei auswerten.

• Verwenden Sie die systemeigene Option Run and Debug von Visual Studio Code, wählen Sie den Hyperlink, um eine launch.json-Datei zu erstellen, und werten Sie die Datei anschließend aus.

Nach der Auswertung der Abfrage werden die Ergebnisse in der Konsole am unteren Rand des Fensters und in einem neuen Bereich mit der Bezeichnung result auf der rechten Seite angezeigt.

Das Ergebnisfenster enthält drei Registerkarten:

• Registerkarte Ausgabe: Zeigt eine Datenvorschau der ausgewerteten Abfrage an. Handelt es sich bei den Daten um eine Tabelle, wird sie als Gitter angezeigt.

  

• Zusammenfassung: Zeigt eine Zusammenfassung der Aktivität an, die die Auswertungen durchgeführt hat, sowie die mit dieser Aktivität verbundenen Statistiken.

  

• Datenquelle: Zeigt allgemeine Informationen über die für die Auswertung verwendete Datenquelle an.

  

Um eine andere Abfrage auszuwerten, ändern Sie einfach die Datei *.query.pq, speichern sie und führen die Auswertungsaufgabe mit einer der drei Methoden erneut aus.

Hinweis

Das Power Query SDK verwaltet keinen Caching-Mechanismus für die Auswertungen.

Ein altes Erweiterungsprojekt in das neue SDK übernehmen

Dieser Abschnitt hilft Connector-Entwicklern, die Erweiterungsprojekte haben, die mit dem alten Visual Studio-basierten Power Query SDKerstellt wurden.

Wir empfehlen, die Connectorprojekte aus unserem DataConnectors Repository für das TripPin-Beispielherunterzuladen, insbesondere das Beispiel 9-TestConnection.

Führen Sie die folgenden Schritte aus, um das alte Erweiterungsprojekt in das neue SDK zu übernehmen:

1. Wählen Sie in Visual Studio-Code Datei>Ordner öffnen, und navigieren Sie dann zu dem Ordner, in dem sich Ihr Erweiterungsprojekt befindet.

2. Richten Sie einen Workspace ein, indem Sie den vorhandenen Ordner und seinen Inhalt mit einer der beiden folgenden Methoden verwenden:

   • Das Power Query SDK verfügt über einen Mechanismus zur Erkennung des Inhalts Ihres Ordners und schlägt vor, dass Sie die Konvertierung in einen neuen Power Query SDK-Workspace aktivieren.

     

   • Führen Sie den Setup-Workspace und den Build Task aus dem Terminalmenü aus. Damit werden effektiv die Datei .mez und die Dateien settings.json erstellt, die für den Workspace benötigt werden.

Durch das Hinzufügen von zwei neuen Ordnern und Dateien wird der aktuelle Workspace in einen neuen Power Query SDK-Workspace umgewandelt.

Arbeitsbereich einrichten

Die Aufgabe „Arbeitsbereich einrichten“ besteht darin, eine Datei settings.json für Ihren Arbeitsbereich zu erstellen, in der einige Variablen festgelegt sind, die für Ihren Arbeitsbereich verwendet werden, wenn es um Auswertungen und allgemeine Einstellungen geht.

Erstellen einer Erweiterungsdatei

Mit dem Build-Task können Sie bei Bedarf die.mez-Datei für Ihre Erweiterung erstellen.

Funktion TestConnection ausführen

TestConnection ist eine Funktion, die es ermöglicht, Ihren Connector in der Microsoft Cloud über Dienste wie Power BI zu aktualisieren. Es handelt sich dabei um einen Datensatz, der innerhalb des Datensatzes Ihrer Connector-Datenquelle implementiert ist. Sie können mehr über die Implementierung des TestConnection-Handlers aus dem Beispiel erfahren, das für die Testverbindungverfügbar ist.

Die Aufgabe zur Ausführung von TestConnection ermöglicht es Ihnen, den Handler innerhalb des Power Query SDK zu testen, ohne diesen Handler manuell in der Microsoft Cloud ausprobieren zu müssen.

Um diese Aufgabe auszuführen, legen Sie zunächst einen Berechtigungsnachweis für Ihren Connector fest und führen dann die Aufgabe entweder über den Abschnitt Power Query SDK im Explorer oder über die Liste der Aufgaben im Terminalmenü aus.

Das Ergebnis dieser Aufgabe wird im Ausgabeterminal am unteren Rand des Fensters angezeigt.

Rückmeldungen und Bugs

Wenn Sie Hilfe bei der Entwicklung Ihres benutzerdefinierten Connectors benötigen oder Feedback, Vorschläge oder Fehler haben, die Sie melden möchten, besuchen Sie unsere offizielle öffentliches Repository auf GitHub.

Sie können das Power BI Community Forum nutzen, um allgemeine Fragen zu Power Query, der Sprache M und der Entwicklung von benutzerdefinierten Connectors zu stellen.