Información general del SDK de Power Query

  • Artículo

El SDK de Power Query es un conjunto de herramientas diseñadas para ayudarle a crear conectores de Power Query. Estos conectores se conocen a menudo como conectores personalizados o extensiones de Power Query.

Los conectores personalizados permiten crear nuevos orígenes de datos o personalizar y ampliar un origen actual. Entre los casos de uso comunes se incluye:

  • Crear una vista de una API REST fácil de usar para analistas de negocios.
  • Proporcionar personalización de marca para un origen que Power Query admite con un conector actual (como un servicio OData o un controlador ODBC).
  • Implementar el flujo de autenticación de OAuth v2 para una oferta de SaaS.
  • Exponer una vista limitada o filtrada sobre el origen de datos para mejorar la facilidad de uso.
  • Habilitar DirectQuery para un origen de datos mediante un controlador ODBC.

Instalación del SDK de Power Query

Actualmente hay dos versiones del SDK de Power Query disponibles:

  • SDK de Power Query para Visual Studio: publicado en 2017 como extensión de Visual Studio 2017 y 2019.
  • SDK de Power Query para Visual Studio Code (versión preliminar): publicado en 2022 como la forma nueva y recomendada para crear conectores de Power Query.

Animamos a todos los desarrolladores a instalar y usar el SDK de Power Query para Visual Studio Code (versión preliminar), porque esta versión será el SDK predeterminado en el futuro.

SDK de Power Query para Visual Studio

Siga los pasos que se indican a continuación para instalar el SDK de Power Query para Visual Studio:

  1. Instale el SDK de Power Query desde Visual Studio Marketplace.
  2. Cree un nuevo proyecto de conector de datos.
  3. Defina la lógica del conector.
  4. Compile el proyecto para generar un archivo de extensión.

Característica en vista previa (GB).

SDK de Power Query para Visual Studio Code (versión preliminar)

Nota:

El nuevo SDK de Power Query para Visual Studio Code se encuentra actualmente en versión preliminar pública desde septiembre de 2022.

Instale el nuevo SDK de Power Query para Visual Studio Code desde la sección de Visual Studio Code en Visual Studio Marketplace. Seleccione Instalar para instalar el SDK.

Proceso de desarrollo del conector

Aunque puede usar el SDK de Power Query para Visual Studio Code o para Visual Studio, ambos usan un proceso similar para el desarrollo de un conector en líneas generales.

En las siguientes secciones se describe, a grandes rasgos, el proceso más común para crear un conector de Power Query con el SDK.

Creación de una nueva extensión

Para crear un nuevo proyecto (SDK de Power Query para Visual Studio) o una nueva área de trabajo (SDK de Power Query para Visual Studio Code), comience con los siguientes archivos principales:

  • Archivo de definición del conector (<connectorName.pq>)
  • Un archivo de consulta (<connectorName.query.pq>)
  • Un archivo de recursos de cadena (resources.resx)
  • Archivos PNG de varios tamaños que se usan para crear iconos

El archivo de definición del conector comienza con una descripción vacía del origen de datos. Puede obtener más información sobre un origen de datos en el contexto del SDK de Power Query en este artículo sobre el control del acceso a los datos.

Prueba

El SDK de Power Query proporciona funcionalidad básica de ejecución de consultas, lo que le permite probar la extensión sin tener que cambiar a Power BI Desktop.

Archivo de prueba de consulta

Además del archivo de extensión, los proyectos de conector de datos pueden tener un archivo de consulta (name.query.pq). Este archivo se puede usar para ejecutar consultas de prueba en Visual Studio. La evaluación de consultas incluye automáticamente el código de la extensión, sin tener que registrar el archivo.pqx, lo que permite llamar a funciones compartidas o probarlas en el código de la extensión.

El archivo de consulta puede contener una sola expresión (por ejemplo, HelloWorld.Contents()), una expresión let (por ejemplo, lo que generaría Power Query) o un documento de sección.

Compilación e implementación

Al compilar el proyecto se genera el archivo .mez o archivo de extensión.

Las extensiones de Power Query se agrupan en un archivo ZIP y se les da la extensión de archivo .mez. En tiempo de ejecución, Power BI Desktop carga extensiones de [Documentos]\Microsoft Power BI Desktop\Conectores personalizados.

Nota:

Los proyectos de conector de datos no admiten pasos de compilación posteriores personalizados para copiar el archivo de extensión en el directorio [Documentos]\Microsoft Power BI Desktop\Conectores personalizados. Si esto es algo que desea hacer, es posible que quiera usar una extensión de terceros.

Las extensiones se definen en un documento de sección de M. Un documento de sección tiene un formato ligeramente diferente al de los documentos de consulta generados en Power Query. El código que se importa desde Power Query suele requerir modificaciones para ajustarlo a un documento de sección, pero son cambios menores. Entre las diferencias de un documento de sección que debe tener en cuenta, se incluyen las siguientes:

  • Comienza con una declaración de sección (por ejemplo, section HelloWorld;).
  • Cada expresión termina con un punto y coma (por ejemplo, a = 1; o b = let c = 1 + 2 in c;).
  • Todas las funciones y variables son locales en el documento de sección, a menos que se marquen como compartidas. Las funciones compartidas se vuelven visibles para otras consultas o funciones, y se pueden considerar como exportaciones de la extensión (es decir, se pueden llamar desde Power Query).

Puede consultar más información sobre los documentos de sección de M en la especificación del lenguaje M.

Distribución de conectores de datos

Los conectores de Power Query se pueden usar en Power BI Desktop o en la experiencia de Power Query Online, como flujos de datos de Power BI, datamarts de Power BI y otras experiencias.

Power BI Desktop

Los usuarios de Power BI Desktop pueden seguir los pasos que se indican a continuación para consumir un conector personalizado de Power Query:

  1. Copie el archivo de extensión (.mez o.pqx) en [Documentos]/Power BI Desktop/Conectores personalizados.
  2. En Power BI Desktop, seleccione (Opción no recomendada) Permitir que se cargue cualquier extensión sin ninguna validación ni advertencia en Archivo>Opciones y configuración>Opciones>Seguridad>Extensiones de datos.
  3. Reinicie Power BI Desktop.

Power BI Desktop carga automáticamente las extensiones al reiniciarse.

Como propietario del origen de datos y del conector, también puede enviar el conector al programa de certificación de conectores de Power Query para que se distribuya con Power BI Desktop en cada versión.

Power Query Online

Nota:

El equipo de Power Query está trabajando duro para habilitar todos los conectores certificados de Power Query en la experiencia de Power Query Online.

En la experiencia de Power Query online, se muestran solamente los conectores certificados de Power Query. Para obtener más información sobre el programa de certificación de conectores de Power Query, consulte Certificación de conectores de Power Query.