Een connector ontwikkelen met behulp van de Power Query SDK
De Power Query SDK is een set hulpprogramma's die zijn ontworpen om u te helpen bij het maken van Power Query-connectors. Deze connectors worden vaak aangepaste connectors of Power Query-extensies genoemd.
Met aangepaste connectors kunt u nieuwe gegevensbronnen maken of een bestaande bron aanpassen en uitbreiden. Veelvoorkomende gebruiksvoorbeelden zijn:
- Een bedrijfsanalistvriendelijke weergave maken voor een REST API.
- Huisstijl bieden voor een bron die door Power Query wordt ondersteund met een bestaande connector (zoals een OData-service of ODBC-stuurprogramma).
- OAuth v2-verificatiestroom implementeren voor een SaaS-aanbieding.
- Het weergeven van een beperkte of gefilterde weergave over uw gegevensbron om de bruikbaarheid te verbeteren.
- DirectQuery inschakelen voor een gegevensbron met behulp van een ODBC-stuurprogramma.
Installeer de Visual Studio Code Power Query SDK vanuit de sectie Visual Studio Code van Visual Studio Marketplace. Selecteer Installeren om de SDK te installeren.
In de volgende secties wordt op hoog niveau het meest voorkomende proces beschreven voor het maken van een Power Query-connector met behulp van de SDK.
Wanneer u een nieuwe werkruimte maakt (Visual Studio Code Power Query SDK), begint u met de volgende kernbestanden:
- Definitiebestand van connector (<connectorName.pq>)
- Een querybestand (<connectorName.query.pq>)
- Een tekenreeksresourcebestand (resources.resx)
- PNG-bestanden van verschillende grootten die worden gebruikt om pictogrammen te maken
Het definitiebestand van de connector begint met een lege beschrijving van de gegevensbron. Meer informatie over een gegevensbron vindt u in de context van de Power Query SDK in het artikel over het verwerken van gegevenstoegang.
De Power Query SDK biedt eenvoudige mogelijkheden voor het uitvoeren van query's, zodat u uw extensie kunt testen zonder over te schakelen naar een andere clienttoepassing. U kunt uw connector verder testen in een toepassing, zoals:
Naast het extensiebestand kunnen Data Connector-projecten een querybestand (name.query.pq) hebben. Dit bestand kan worden gebruikt om testquery's uit te voeren in Visual Studio Code. De queryevaluatie bevat automatisch uw extensiecode, zonder dat u uw.pqx-bestand hoeft te registreren, zodat u gedeelde functies in uw extensiecode kunt aanroepen of testen.
Het querybestand kan één expressie bevatten (bijvoorbeeld HelloWorld.Contents()
), een let
expressie (zoals wat Power Query zou genereren) of een sectiedocument.
Het bouwen van uw project produceert uw .mez-bestand of extensiebestand. Power Query-extensies worden gebundeld in een ZIP-bestand en krijgen een mez-bestandsextensie.
Extensies worden gedefinieerd in een M-sectiedocument. Een sectiedocument heeft een iets andere indeling dan de querydocument(en) die zijn gegenereerd in Power Query. Code die u importeert vanuit Power Query, moet doorgaans worden aangepast aan een sectiedocument, maar de wijzigingen zijn minder groot. Verschillen in sectiedocument die u moet kennen, zijn onder andere:
- Ze beginnen met een sectiedeclaratie (bijvoorbeeld
section HelloWorld;
). - Elke expressie eindigt met een puntkomma (bijvoorbeeld
a = 1;
ofb = let c = 1 + 2 in c;
). - Alle functies en variabelen zijn lokaal in het sectiedocument, tenzij ze zijn gemarkeerd als gedeeld. Gedeelde functies worden zichtbaar voor andere query's/functies en kunnen worden beschouwd als de exports voor uw extensie (dat wil gezegd, ze kunnen worden aangeroepen vanuit Power Query).
Meer informatie over M-sectiedocumenten vindt u in de M-taalspecificatie.
U hebt twee paden waarin u de connector kunt distribueren:
- Zelfdistributie
- Connectorcertificering
Een selfservicemechanisme waarin u aangepaste Power Query-connectors kunt toepassen in toepasselijke productervaringen
Wanneer uw connector is gemaakt, kunt u dit bestand verzenden naar wens voor uw gebruikers en kunnen ze de connector gebruiken in toepasselijke productervaringen, zoals Microsoft Power BI.
U kunt uw eigen aangepaste connector gebruiken in Microsoft Power BI Desktop en de Microsoft Power BI-service voor Semantische modellen voor vernieuwing en connectiviteit in de cloud.
Power Query-connectors kunnen in drie ervaringen worden geladen:
- On-premises gegevensgateway: uw connector kan worden geladen via de gateway die moet worden gebruikt in de Microsoft Fabric- en Microsoft-Power BI-service s
- Power Query Online: binnen ervaringen zoals Power BI Datamarts, Fabric Dataflow Gen2 en vele andere
- Power Query Desktop: binnen ervaringen zoals Power BI Desktop.
Meer informatie over het gebruik van uw aangepaste connector voor zelfdistributie vindt u in de onderstaande artikelen:
- Een aangepaste Power Query-connector laden in Power BI Desktop
- Aangepaste connectors inschakelen en gebruiken in de Power BI-service
Met het certificeringsprogramma van de Data Factory-connector kunt u uw connector indienen bij Microsoft voor certificering waarbij Microsoft zorgt voor het publiceren en distribueren van uw connector in zowel Microsoft Fabric als Microsoft Power BI voor toepasselijke producten en ervaringen:
- 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 en anderen
- On-premises gegevensgateway: voor zowel Microsoft Fabric als Microsoft Power BI die een gateway gebruiken voor geverifieerde vernieuwing of connectiviteit.
Meer informatie over het Data Factory Connector-certificeringsprogramma.