Share via

Visão geral do 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

Atualmente, há duas versões do SDK do Power Query disponíveis:

  • Visual Studio Power Query SDK: lançado em 2017 como uma extensão para o Visual Studio 2017 e 2019.
  • Visual Studio Code Power Query SDK (Pré-visualização): Lançado em 2022 como a forma nova e recomendada de criar conectores do Power Query.

Incentivamos todos os desenvolvedores a instalar e usar o recém-lançado Visual Studio Code Power Query SDK (Preview), pois esta versão acabará sendo o SDK padrão no futuro.

Visual Studio Power Query SDK

Siga as etapas abaixo para instalar o SDK do Visual Studio Power Query:

  1. Instale o SDK do Power Query a partir do Visual Studio Marketplace.
  2. Crie um novo projeto de conector de dados.
  3. Defina a lógica do conector.
  4. Construa o projeto para produzir um arquivo de extensão.

Funcionalidade de pré-visualização.

SDK do Power Query do Visual Studio Code (Pré-visualização)

Nota

O novo SDK do Visual Studio Code Power Query está atualmente em pré-visualização pública desde setembro de 2022.

Instale o novo 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

Embora você possa usar o Visual Studio Code ou o Visual Studio Power Query SDK, ambos usam um processo semelhante para o desenvolvimento de um conector em alto nível.

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 projeto (SDK do Visual Studio Power Query) ou um novo espaço de trabalho (SDK do Power Query do 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çará com uma descrição da fonte de dados vazia. 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 recursos básicos de execução de consulta, permitindo que você teste sua extensão sem precisar alternar para o Power BI Desktop.

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. 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. Em tempo de execução, o Power BI Desktop carrega extensões de [Documentos]\Microsoft Power BI Desktop\Conectores Personalizados.

Nota

Os projetos do Data Connector não suportam etapas de pós-compilação personalizadas para copiar o arquivo de extensão para o diretório [Documents]\Microsoft Power BI Desktop\Custom Connectors. Se isso é algo que você quer fazer, você pode querer usar uma extensão de terceiros.

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 de dados

Os conectores do Power Query podem ser usados no Power BI Desktop ou na experiência do Power Query Online, como fluxos de dados do Power BI, datamarts do Power BI e outras experiências.

Power BI Desktop

Os utilizadores do Power BI Desktop podem seguir os passos abaixo para consumir um conector personalizado do Power Query:

  1. Copie o arquivo de extensão (.mez or.pqx) para [Documentos]/Power BI Desktop/Conectores Personalizados.
  2. No Power BI Desktop, selecione a opção (Não Recomendado) Permitir que qualquer extensão seja carregada sem validação ou aviso em Opções de Arquivo>e configurações>Opções>Extensões de Dados de Segurança.>
  3. Reinicie o Power BI Desktop.

O Power BI Desktop carregará automaticamente as extensões na reinicialização.

Como alternativa, como proprietário da fonte de dados e do conector, você pode enviar seu conector para o programa de Certificação do Conector do Power Query para que ele seja fornecido com o Power BI Desktop em todas as versões.

Power Query Online

Nota

A equipa do Power Query está a trabalhar arduamente para ativar todos os conectores certificados pelo Power Query na experiência do Power Query Online.

Apenas os conectores certificados do Power Query são apresentados na experiência do Power Query Online. Para saber mais sobre o programa de certificação do conector do Power Query, vá para Certificação do conector do Power Query.