Power Query SDK Übersicht

  • Artikel

Das Power Query SDK ist eine Reihe von Tools, mit denen Sie Power Query-Connectors erstellen können. Diese Connectors werden häufig als benutzerdefinierte Connectors oder Power Query-Erweiterungen bezeichnet.

Mit benutzerdefinierten Connectors können Sie neue Datenquellen erstellen oder eine vorhandene Quelle anpassen und erweitern. Gängige Anwendungsfälle:

  • Erstellen einer für Geschäftsanalysten geeigneten Ansicht für eine REST-API.
  • Bereitstellung von Branding für eine Quelle, die Power Query mit einem vorhandenen Konnektor (z. B. einem OData-Dienst oder ODBC-Treiber) unterstützt.
  • Implementierung des OAuth v2-Authentifizierungsflusses für ein SaaS-Angebot.
  • Offenlegung einer eingeschränkten oder gefilterten Ansicht Ihrer Datenquelle zur Verbesserung der Benutzerfreundlichkeit.
  • Aktivieren von DirectQuery für eine Datenquelle mithilfe eines ODBC-Treibers.

Installieren des Power Query SDK

Derzeit sind zwei Versionen des Power Query SDK verfügbar:

  • Visual Studio Power Query SDK: Herausgegeben 2017 als eine Erweiterung für Visual Studio 2017 und 2019.
  • Visual Studio Code Power Query SDK (Vorschau): Veröffentlicht im Jahr 2022 als neue und empfohlene Methode zur Erstellung von Power Query Connectors.

Wir empfehlen allen Entwicklern, das neu veröffentlichte Visual Studio Code Power Query SDK (Preview) zu installieren und zu verwenden, da diese Version in Zukunft das Standard-SDK sein wird.

Visual Studio Power Query SDK

Folgen Sie den nachstehenden Schritten, um das Visual Studio Power Query SDK zu installieren:

  1. Installieren Sie das Power Query SDK aus dem Visual Studio Marketplace.
  2. Erstellen Sie ein neues Datenkonnektoren-Projekt.
  3. Definieren Sie Ihre Connector-Logik.
  4. Erstellen Sie das Projekt, um eine Erweiterungsdatei zu erzeugen.

Previewfunktion.

Visual Studio Code Power Query SDK (Vorschau)

Hinweis

Das neue Visual Studio Code Power Query SDK verfügt seit September 2022 über eine öffentliche Vorschau.

Installieren Sie das neue Visual Studio Code Power Query SDK aus dem Visual Studio Code-Bereich des Visual Studio Marketplace. Klicken Sie auf Installieren, um SDK zu installieren.

Prozess der Entwicklung des Connectors

Sie können entweder den Visual Studio Code oder das Visual Studio Power Query SDK verwenden. Beide verwenden einen ähnlichen Prozess für die Entwicklung eines Connectors auf hohem Niveau.

Die folgenden Abschnitte geben Ihnen einen Überblick über die gängigsten Verfahren zur Erstellung eines Power Query Connectors mithilfe des SDK.

Erstellung einer neuen Erweiterung

Beim Erstellen eines neuen Projekts (Visual Studio Power Query SDK) oder eines neuen Arbeitsbereichs (Visual Studio Code Power Query SDK) beginnen Sie mit den folgenden Core-Dateien:

  • Connector Definitionsdatei (<connectorName>.pq)
  • Eine Abfragedatei (<connectorName>.query.pq)
  • Eine String-Ressourcen-Datei (resources.resx)
  • PNG-Dateien in verschiedenen Größen zum Erstellen von Symbolen

Ihre Connector-Definitionsdatei wird mit einer leeren Datenquellenbeschreibung beginnen. Mehr über eine Datenquelle im Zusammenhang mit dem Power Query SDK erfahren Sie in dem Artikel über Handhabung des Datenzugriffs.

Testen

Das Power Query SDK bietet grundlegende Funktionen zur Ausführung von Abfragen, mit denen Sie Ihre Erweiterung testen können, ohne zu Power BI Desktop wechseln zu müssen.

Testdatei abfragen

Zusätzlich zur Erweiterungsdatei können Data Connector Projekte eine Abfragedatei (name.query.pq) enthalten. Diese Datei kann verwendet werden, um Testabfragen in Visual Studio auszuführen. Die Abfrageauswertung wird automatisch Ihren Erweiterungscode einbeziehen, ohne dass Sie Ihre.pqx-Datei registrieren müssen, so dass Sie alle gemeinsam genutzten Funktionen in Ihrem Erweiterungscode aufrufen oder testen können.

Die Abfragedatei kann einen einzelnen Ausdruck (z. B. HelloWorld.Contents()), einen let Ausdruck (wie ihn Power Query erzeugen würde) oder ein Abschnittsdokument enthalten.

Erstellen und Bereitstellen

Wenn Sie Ihr Projekt erstellen, erhalten Sie Ihre .mez-Datei oder Erweiterungsdatei.

Power Query-Erweiterungen werden in einer ZIP-Datei gebündelt und erhalten die Dateierweiterung .mez. Zur Runtime lädt Power BI Desktop Erweiterungen aus [Dokumente]\Microsoft Power BI Desktop\Custom Connectors.

Hinweis

Data Connector-Projekte unterstützen keine benutzerdefinierten Post-Build-Schritte zum Kopieren der Erweiterungsdatei in Ihr Verzeichnis [Dokumente]\Microsoft Power BI Desktop\Custom Connectors. Wenn Sie dies tun möchten, sollten Sie eine Erweiterung eines Drittanbieters verwenden.

Erweiterungen werden in einem M-Abschnitt-Dokument definiert. Ein Abschnittsdokument hat ein etwas anderes Format als das/die in Power Query generierte(n) Abfragedokument(e). Code, den Sie aus Power Query importieren, muss in der Regel geändert werden, damit er in ein Abschnittsdokument passt, aber die Änderungen sind gering. Zu den Unterschieden zwischen den Abschnittsdokumenten, die Sie kennen sollten, gehören:

  • Sie beginnen mit einer Abschnittserklärung (zum Beispiel section HelloWorld;).
  • Jeder Ausdruck endet mit einem Semikolon (zum Beispiel a = 1; oder b = let c = 1 + 2 in c;).
  • Alle Funktionen und Variablen sind lokal für das Abschnittsdokument, es sei denn, sie sind als gemeinsam genutzt gekennzeichnet. Gemeinsam genutzte Funktionen werden für andere Abfragen/Funktionen sichtbar und können als Exporte für Ihre Erweiterung betrachtet werden (d. h. sie werden von Power Query aus aufrufbar).

Weitere Informationen zu den Dokumenten der Sektion M finden Sie in der M-Language-Spezifikation.

Verteilung von Daten-Connectoren

Power Query Connectoren können in Power BI Desktop oder Power Query Online verwendet werden, z.B. in Power BI Datenflüssen, Power BI Datamarts und anderen Anwendungen.

Power BI Desktop

Benutzer von Power BI Desktop können die folgenden Schritte ausführen, um einen benutzerdefinierten Power Query Connector zu verwenden:

  1. Kopieren Sie die Erweiterungsdatei (.mez oder.pqx) in [Dokumente]/Power BI Desktop/Custom Connectors.
  2. Wählen Sie in Power BI Desktop die Option (Nicht empfohlen) Erlaubt das Laden jeder Erweiterung ohne Überprüfung oder Warnung Option unter Datei>Optionen und Einstellungen>Optionen>Sicherheit>Datenerweiterungen.
  3. Starten Sie Power BI Desktop neu.

Power BI Desktop wird die Erweiterungen beim Neustart automatisch laden.

Alternativ können Sie als Besitzer der Datenquelle und des Connectors Ihren Connector beim Power Query Connector Zertifizierungsprogramm einreichen, so dass er in jeder Version mit Power BI Desktop ausgeliefert wird.

Power Query Online

Hinweis

Das Power Query Team arbeitet hart daran, alle Power Query zertifizierten Konnektoren in Power Query Online zu aktivieren.

Nur Power Query-zertifizierte Connectoren werden in der Power Query Online-Ansicht angezeigt. Wenn Sie mehr über das Power Query Connector Zertifizierungsprogramm erfahren möchten, siehe Power Query Connector Zertifizierung.