Desenvolver um conector usando o SDK do Power Query

  • Artigo

O SDK do Power Query é um conjunto de ferramentas projetado para ajudá-lo a criar conectores do Power Query. Esses conectores geralmente são chamados de conectores personalizados ou extensões do Power Query.

Os conectores personalizados permitem que você crie novas fontes de dados ou personalize e estenda uma fonte existente. Os casos de uso comuns incluem:

  • Criar uma exibição de uma API REST fácil de usar por analistas de negócios.
  • Fornecer identidade visual usando um conector existente para uma fonte que o Power Query suporta (como por exemplo, um serviço OData ou driver ODBC).
  • Implementar o fluxo de autenticação do OAuth v2 para uma oferta de SaaS.
  • Expor uma exibição limitada ou filtrada sobre a fonte de dados para aprimorar a usabilidade.
  • Habilitar o DirectQuery para uma fonte de dados usando um driver ODBC.

Instalação do SDK do Power Query

Instale o SDK do Power Query para Visual Studio Code na seção Visual Studio Code do Visual Studio Marketplace. Selecione Instalar para instalar o SDK.

Processo de desenvolvimento de conector

As seguintes seções descrevem, em um nível mais alto, o processo mais comum para criar um conector do Power Query usando o SDK.

Criando uma nova extensão

Ao criar um novo espaço de trabalho (SDK do Power Query para Visual Studio Code), você começa com os seguintes arquivos principais:

  • Arquivo de definição do conector (<connectorName>.pq)
  • Um arquivo de consulta (<connectorName>.query.pq)
  • Um arquivo de recurso de cadeia de caracteres (resources.resx)
  • Arquivos PNG de vários tamanhos usados para criar ícones

O arquivo de definição do conector começa com uma descrição vazia da fonte de dados. Você pode saber mais sobre uma fonte de dados no contexto do SDK do Power Query no artigo Lidando com o acesso a dados.

Testando

O SDK do Power Query fornece capacidades básicas de execução de consulta, permitindo que você teste a extensão sem precisar mudar para um aplicativo cliente diferente. Você pode testar ainda mais seu conector em um aplicativo, como:

Arquivo de teste de consulta

Além do arquivo de extensão, os projetos do Conector de Dados podem ter um arquivo de consulta (name.query.pq). Esse arquivo pode ser usado para executar consultas de teste no Visual Studio Code. A avaliação da consulta incluirá automaticamente seu código de extensão, sem precisar registrar seu arquivo .pqx, permitindo que você chame ou teste quaisquer funções compartilhadas em seu código de extensão.

O arquivo de consulta pode conter uma única expressão (por exemplo, HelloWorld.Contents()), uma expressão let (como o que Power Query geraria) ou um documento de seção.

Criar e implantar

A construção do seu projeto gera o arquivo .mez ou arquivo de extensão. As extensões do Power Query são agrupadas em um arquivo ZIP e recebem uma extensão de arquivo .mez.

As extensões são definidas em um documento da seção M. Um documento de seção tem um formato ligeiramente diferente dos documentos de consulta gerados no Power Query. O código importado do Power Query normalmente requer modificação para caber em um documento de seção, mas as alterações são secundárias. As diferenças de documento da seção que você deve conhecer incluem:

  • Eles começam com uma declaração de seção (por exemplo, section HelloWorld;).
  • Cada expressão termina com um ponto e vírgula (por exemplo, a = 1; ou b = let c = 1 + 2 in c;).
  • Todas as funções e variáveis são locais ao documento de seção, a menos que estejam marcadas como compartilhadas. As funções compartilhadas tornam-se visíveis para outras consultas/funções e podem ser consideradas como exportações para sua extensão (ou seja, elas podem ser chamadas do Power Query).

Mais informações sobre os documentos da seção M podem ser encontradas na Especificação da Linguagem M..

Distribuição de conectores do Power Query

Você tem dois caminhos nos quais pode distribuir o conector:

  • Autodistribuição
  • Certificação do conector

Autodistribuição

Um mecanismo de autoatendimento em que você pode aplicar conectores personalizados do Power Query em experiências de produto aplicáveis

Com o conector criado, você pode enviar esse arquivo como desejar para os usuários e eles podem usar o conector em experiências de produto aplicáveis, como o Microsoft Power BI.

Microsoft Power BI

Você pode usar seu próprio conector personalizado no Microsoft Power BI Desktop e no Serviço do Microsoft Power BI para modelos semânticos para atualização e conectividade na nuvem.

Os conectores do Power Query podem ser carregados em três experiências:

  • Gateway de dados local: o conector pode ser carregado por meio do gateway para ser usado nos serviços do Microsoft Fabric e do Microsoft Power BI
  • Power Query Online: em experiências, como Datamarts do Power BI, fluxo de dados Gen2 do Fabric e muitos outros
  • Power Query Desktop: em experiências como o Power BI Desktop.

Saiba mais sobre como usar o conector personalizado para autodistribuição usando os artigos abaixo:

Certificação do conector

O programa de certificação do conector do Data Factory permite que você envie o conector para a Microsoft para certificação, onde a Microsoft se encarrega de publicar e distribuir o conector no Microsoft Fabric e no Microsoft Power BI para produtos e experiências aplicáveis:

  • Power Query Desktop: Microsoft Power BI Desktop.
  • Power Query Online: fluxo de dados Gen2 do Microsoft Fabric, depósito do Microsoft Fabric, datamarts do Microsoft Power BI, fluxo de dados Gen1 do Microsoft Power BI e outros
  • Gateway de dados local: para o Microsoft Fabric e o Microsoft Power BI que usam um gateway para atualização ou conectividade autenticada.

Saiba mais sobre o programa de Certificação do conector do Data Factory.