Vue d’ensemble Power Query SDK

  • Article

Le Power Query SDK est un jeu d’outils conçus pour vous aider à créer des connecteurs Power Query. Ces connecteurs sont souvent appelés connecteurs personnalisés ou extensions Power Query.

Les connecteurs personnalisés vous permettent de créer de nouvelles sources de données ou de personnaliser et d’étendre une source existante. Les cas d’utilisation courants sont les suivants :

  • Création d’une vue conviviale pour une API REST.
  • Fourniture d’une personnalisation pour une source prise en charge par Power Query avec un connecteur existant (par exemple, un service OData ou un pilote ODBC).
  • Implémentation du flux d’authentification OAuth v2 pour une offre SaaS.
  • Exposition d’une vue limitée ou filtrée de votre source de données pour faciliter l’utilisation.
  • Activation de DirectQuery pour une source de données à l’aide d’un pilote ODBC.

Installation du Kit de développement logiciel (SDK) Power Query

Il existe actuellement deux versions du Power Query SDK disponibles :

  • Visual Studio Power Query SDK : publié en 2017 en tant qu’extension pour Visual Studio 2017 et 2019.
  • Visual Studio Code Power Query SDK (Preview) : publié en 2022 comme nouvelle méthode recommandée pour créer des connecteurs Power Query.

Nous encourageons tous les développeurs à installer et à utiliser le Visual Studio Code Power Query SDK (Preview) car cette version sera finalement le SDK par défaut à l’avenir.

Visual Studio Power Query SDK

Suivez les étapes ci-dessous pour installer le Visual Studio Power Query SDK :

  1. Installez le Kit de développement logiciel (SDK) Power Query à partir de la Place de marché Visual Studio.
  2. Créez un projet de connecteur de données.
  3. Définissez la logique de votre connecteur.
  4. Générez le projet pour produire un fichier d’extension.

Fonctionnalité d’évaluation.

Visual Studio Code Power Query SDK (Preview)

Remarque

Le nouveau Visual Studio Code Power Query SDK est actuellement en préversion publique à compter de septembre 2022.

Installez le nouveau Visual Studio Code Power Query SDK à partir de la section Visual Studio Code de Place de marché Visual Studio. Sélectionnez Installer pour installer le SDK.

Processus de développement du connecteur

Bien que vous puissiez utiliser Visual Studio Code ou le Visual Studio Power Query SDK, les deux utilisent un processus similaire pour le développement d’un connecteur à un niveau élevé.

Les sections suivantes décrivent, à un niveau élevé, le processus le plus courant pour créer un connecteur Power Query à l’aide du SDK.

Créer une nouvelle extension

Lors de la création d’un projet (Visual Studio Power Query SDK) ou d’un nouvel espace de travail (Visual Studio Code Power Query SDK), vous commencez par les fichiers cœurs suivants :

  • Fichier de définition du connecteur (<connectorName.pq>)
  • Un fichier de requête (<connectorName>.query.pq)
  • Fichier de ressource de chaîne (resources.resx)
  • Fichiers PNG de différentes tailles utilisées pour créer des icônes

Votre fichier de définition de connecteur commencera par une description de source de données vide. Vous pouvez en savoir plus sur une source de données dans le contexte du Power Query SDK à partir de l’article sur la gestion de l’accès aux données.

Test

Le Kit de développement logiciel (SDK) Power Query fournit des fonctionnalités d’exécution de requête de base qui vous permettent de tester votre extension sans avoir à basculer vers Power BI Desktop.

Fichier de test de requête

Outre le fichier d’extension, les projets de connecteur de données peuvent avoir un fichier de requête (nom.query.pq). Ce fichier peut être utilisé pour exécuter des requêtes de test dans Visual Studio. L’évaluation de la requête inclura automatiquement votre code d’extension, sans avoir à enregistrer votre fichier .pqx, ce qui vous permettra d’appeler ou de tester toutes les fonctions partagées dans votre code d’extension.

Le fichier de requête peut contenir une expression unique (par exemple, HelloWorld.Contents()), une expression let (comme ce que Power Query générerait) ou un document de section.

Générer et déployer

La création de votre projet produit votre fichier ou fichier d’extension .mez.

Les extensions Power Query sont regroupées dans un fichier ZIP avec une extension de fichier .mez. Au moment de l’exécution, Power BI Desktop charge les extensions à partir de [Documents]\Microsoft Power BI Desktop\Custom Connectors.

Remarque

Les projets de connecteur de données ne prennent pas en charge les étapes post-build personnalisées pour copier le fichier d’extension dans votre répertoire [Documents]\Microsoft Power BI Desktop\Custom Connectors. Si c’est quelque chose que vous voulez faire, vous pouvez utiliser une extension tierce.

Les extensions sont définies dans un document de section M. Un document de section présente un format légèrement différent de celui des documents de requête générés dans Power Query. Le code que vous importez à partir de Power Query nécessite généralement une modification pour tenir dans un document de section, mais cette modification est mineure. Les différences que vous devez connaître concernant les documents de section sont les suivantes :

  • Ils commencent par une déclaration de section (par exemple, section HelloWorld;).
  • Chaque expression se termine par un point-virgule (par exemple, a = 1; ou b = let c = 1 + 2 in c;).
  • Toutes les fonctions et variables sont locales au document de section, sauf si elles sont marquées comme partagées. Les fonctions partagées deviennent visibles par d’autres requêtes/fonctions, et peuvent être considérées comme des exportations de votre extension (autrement dit, elles deviennent appelables à partir de Power Query).

Pour plus d’informations sur les documents de section M, consultez Spécification du langage M.

La distribution de connecteurs de données

Les connecteurs Power Query peuvent être utilisés dans Power BI Desktop ou dans l’expérience Power Query Online, comme les flux de données Power BI, les datamarts Power BI et d’autres expériences.

Power BI Desktop

Les utilisateurs de Power BI Desktop peuvent suivre les étapes ci-dessous pour consommer un connecteur personnalisé Power Query :

  1. Copiez le fichier d’extension (.mez ou.pqx) dans [Documents]/Power BI Desktop/Custom Connectors.
  2. Dans Power BI Desktop, sélectionnez l’option (Non recommandé) Autoriser le chargement d’une extension sans validation ni avertissement sous Options de fichier>et paramètres>Options>Extensions>de données de sécurité.
  3. Redémarrez Power BI Desktop.

Power BI Desktop chargera automatiquement les extensions lors du redémarrage.

Sinon, en tant que propriétaire de la source de données et du connecteur, vous pouvez soumettre votre connecteur au programme de certification du connecteur Power Query afin qu’il soit fourni avec Power BI Desktop à chaque version.

Power Query Online

Remarque

L’équipe Power Query travaille dur pour activer tous les connecteurs certifiés Power Query dans l’expérience Power Query Online.

Seuls les connecteurs certifiés Power Query sont affichés dans l’expérience Power Query Online. Pour en savoir plus sur le programme de certification du connecteur Power Query, accédez à Certification du connecteur Power Query.