Desenvolver um conector usando o SDK do Power Query

  • Artigo

O SDK do Power Query é um conjunto de ferramentas concebido para o ajudar a criar conectores do Power Query. Estes conectores são frequentemente referidos como conectores personalizados ou extensões do Power Query.

Os conectores personalizados permitem criar novas fontes de dados ou personalizar e estender uma fonte existente. Os casos de uso comuns incluem:

  • Criação de uma visão amigável para analistas de negócios para uma API REST.
  • Fornecer identidade visual para uma fonte que o Power Query suporta com um conector existente (como um serviço OData ou um driver ODBC).
  • Implementação do fluxo de autenticação OAuth v2 para uma oferta de SaaS.
  • Expor uma exibição limitada ou filtrada sobre sua fonte de dados para melhorar a usabilidade.
  • Habilitando o DirectQuery para uma fonte de dados usando um driver ODBC.

Instalar o SDK do Power Query

Instale o SDK do Power Query do Visual Studio Code a partir da seção Código do Visual Studio do Visual Studio Marketplace. Selecione Instalar para instalar o SDK.

Processo de desenvolvimento do conector

As seções a seguir descrevem, em alto nível, 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 (Visual Studio Code Power Query SDK), 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 sobre como lidar com o acesso a dados.

Testar

O SDK do Power Query fornece capacidades básicas de execução de consultas, permitindo-lhe testar a sua extensão sem ter de mudar para uma aplicação 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 Data Connector 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 o seu código de extensão, sem ter que registar o seu ficheiro .pqx, permitindo-lhe chamar ou testar quaisquer funções partilhadas no seu código de extensão.

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

Compilar e implementar

Construir seu projeto produz seu arquivo .mez ou arquivo de extensão. As extensões do Power Query são agrupadas num ficheiro ZIP e recebem uma extensão de ficheiro .mez.

As extensões são definidas dentro de um documento de seção M. Um documento de secção tem um formato ligeiramente diferente do(s) documento(s) de consulta gerado(s) no Power Query. O código importado do Power Query normalmente requer modificação para caber num documento de secção, mas as alterações são menores. As diferenças de documentos de seção que você deve estar ciente incluem:

  • Começam com uma declaração de secçã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 para o documento da seção, a menos que estejam marcadas como compartilhadas. As funções partilhadas tornam-se visíveis para outras consultas/funções e podem ser consideradas como as exportações para a sua extensão (ou seja, tornam-se chamáveis a partir do Power Query).

Mais informações sobre 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 você pode distribuir seu conector:

  • Auto-distribuição
  • Certificação de conectores

Auto-distribuição

Um mecanismo de autoatendimento onde 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 seus usuários e eles podem usá-lo 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 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: seu conector pode ser carregado por meio do gateway para ser usado nos serviços Microsoft Fabric e Microsoft Power BI
  • Power Query Online: em experiências como Power BI Datamarts, Fabric Dataflow Gen2 e muitas outras
  • Power Query Desktop: em experiências como o Power BI Desktop.

Você pode saber mais sobre como usar seu conector personalizado para autodistribuição usando os artigos abaixo:

Certificação de conectores

O programa de certificação do conector Data Factory permite que você envie seu conector à Microsoft para certificação, onde a Microsoft se encarrega de publicar e distribuir seu 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: Microsoft Fabric Dataflow Gen2, Microsoft Fabric Warehouse, Microsoft Power BI Datamarts, Microsoft Power BI Dataflow Gen1 e outros
  • Gateway de dados local: para Microsoft Fabric e Microsoft Power BI que usam um gateway para atualização autenticada ou conectividade.

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