Общие сведения о пакете SDK Для Power Query

Статья
05/15/2024

Цель этой статьи — дать обзор общих возможностей и возможностей разработки, найденных в пакете SDK Power Query для Visual Studio Code.

Создание нового проекта

Совет

Перед созданием проекта расширения рекомендуется создать новую папку, в которой будет храниться проект расширения. При создании нового проекта, если папка не выбрана, пакет SDK Power Query поможет вам найти или создать новую папку перед созданием проекта расширения.

После этого в Visual Studio Code в главной области Обозревателя Visual Studio Code есть раздел с именем пакета SDK Power Query. В этом разделе есть только одна кнопка, которая считывает проект расширения. Нажмите эту кнопку.

Создайте кнопку проекта расширения в Visual Studio Code.

Эта кнопка открывает поле ввода в верхней части интерфейса Visual Studio Code. Введите имя нового проекта расширения и нажмите клавишу ВВОД.

Создание проекта расширения и именование проекта.

Через несколько секунд окно Visual Studio Code открывает основной файл *.pq для проекта расширения, содержащего логику соединителя. Пакет SDK Power Query автоматически запускает некоторые необходимые задачи для завершения настройки рабочей области. Эти задачи можно проверить в выходной консоли в Visual Studio Code.

Проект расширения, созданный с помощью шаблона Hello World.

Пакет SDK Power Query автоматически создает следующий набор файлов:

Файл settings.json , который определяет определенные параметры для работы на уровне рабочей области.
Он создает расширение как mez-файл и сохраняет его в новой папке bin\AnyCPU\Debug.
Набор значков соединителя в виде файлов .png.
Файл resources.resx , который служит главным хранилищем строк, используемых в расширении.
PQ-файл, содержащий основную логику расширения или соединителя.
Файл .query.pq, основной целью которого является создание тестовых запросов, которые можно оценить позже.
Proj-файл, содержащий сведения о проекте расширения.

Список файлов соединителя.

После распознавания проекта расширения Visual Studio Code раздел пакета SDK Power Query изменяет его внешний вид, а теперь отображает список задач, которые можно выполнить в новом проекте расширения.

Задачи в разделе пакета SDK Для Power Query.

Подтверждение компетенции

Внимание

Прежде чем вы сможете оценить любой из запросов соединителя данных, сначала необходимо создать набор учетных данных для проекта расширения.

Пакет SDK Power Query предлагает несколько задач с помощью пользовательского интерфейса, чтобы разрешить задавать, перечислять и удалять учетные данные из проекта расширения.

Установка учетных данных

Пакет SDK Power Query в основном зависит от задач, которые можно активировать с помощью нескольких точек входа. Настройка учетных данных может выполняться двумя способами (другие задачи учетных данных можно выполнять так же).

В разделе пакета SDK Power Query в области обозревателя.
В терминале выберите параметр "Выполнить задачу" и выберите задачу "Задать учетные данные".

При выполнении этой задачи Visual Studio Code поможет вам выполнить ряд запросов, позволяющих задать учетные данные. Эти ряды запросов предсказуемы и всегда состоят из одних и того же этапа:

Выберите тип источника данных.
Выберите файл соединителя.
Выберите метод проверки подлинности.

Для существующего проекта расширения доступны анонимный метод проверки подлинности. После установки проверки подлинности сообщение, которое подтверждает успешное создание учетных данных, отображается в правом нижнем углу окна.

Учетные данные были успешно созданы.

Вывод списка учетных данных

Как и при настройке учетных данных, задача для перечисления учетных данных имеет две точки входа в одинаковых местах: раздел ПАКЕТА SDK Power Query в области обозревателя и в меню терминала .

При выполнении этой задачи отображаются доступные учетные данные внутри выходного терминала.

Учетные данные, перечисленные в консоли вывода.

Очистка ВСЕХ учетных данных

Как и в предыдущих двух задачах, задача очистки всех учетных данных имеет две точки входа в одинаковых местах: раздел пакета SDK Power Query в области обозревателя и в меню терминала .

Эта задача служит способом очистки всех учетных данных из текущего сеанса, когда необходимо задать новые учетные данные для оценки запросов.

Информационные сообщения для этой задачи также отображаются в выходной консоли.

Информационное сообщение для задачи

Оценка запроса и панели результатов

Прежде чем вы сможете оценить тестовые запросы, необходимо задать учетные данные. Используя соединитель, созданный в предыдущем разделе, можно открыть *.query.pq файл, который служит в качестве тестового файла запроса.

Для этого конкретного соединителя, в котором имя проекта было MyConnector, код выглядит следующим образом:

// Use this file to write queries to test your data connector
let
    result = MyConnector.Contents()
in
    result

Перед оценкой запроса давайте изменим код следующим образом:

// Use this file to write queries to test your data connector
let
    result = MyConnector.Contents("Hello World")
in
    result

Не забудьте сохранить файл после изменения его кода.

Чтобы оценить этот запрос, у вас есть три варианта:

Щелкните правой кнопкой мыши файл, который используется, и выберите параметр "Оценить текущий файл power query".

Щелкните правой кнопкой мыши текущий файл, чтобы оценить его.

Перейдите в меню терминала и выберите задачу оценки текущего файла .

Выбор текущей задачи файла в меню терминала.

Используйте собственный параметр запуска и отладки в Visual Studio Code, выберите гиперссылку, чтобы создать файл launch.json, а затем оценить файл.

Создайте файл launch.json для оценки запросов с помощью расширяемости запуска и отладки.

После оценки запроса результаты отображаются в консоли в нижней части окна и на новой панели, называемой панелью результатов справа.

Окно Visual Studio Code после завершения оценки показывает выходные данные в консоли и панели результатов.

Панель результатов содержит три вкладки:

Вкладка вывода: отображается предварительный просмотр данных для вычисляемого запроса. Если данные являются таблицей, она отображается в виде сетки.
Сводка. Отображает сводку действия, выполняющего оценки, а также статистику, связанную с этим действием.
DataSource: отображает общие сведения об источнике данных, используемом для оценки.

Чтобы оценить другой запрос, просто измените файл *.query.pq, сохраните его, а затем снова запустите задачу оценки с любым из трех методов.

Примечание.

Пакет SDK Power Query не управляет каким-либо механизмом кэширования для оценки.

Перенос устаревшего проекта расширения в новый пакет SDK

Этот раздел помогает разработчикам соединителей, имеющим проекты расширения, созданные с помощью устаревшего пакета SDK Power Query для Visual Studio.

Для этого мы рекомендуем скачать проекты соединителей, доступные из нашего репозитория DataConnectors для примера TripPin, в частности пример 9-TestConnection.

Чтобы перенести устаревший проект расширения в новый пакет SDK, выполните следующие действия.

В Visual Studio Code выберите папку "Открыть файл>", а затем перейдите в папку, в которой находится проект расширения.
Настройте рабочую область с помощью существующей папки и ее содержимого с помощью одного из следующих двух методов:
- Пакет SDK Power Query имеет механизм для распознавания содержимого папки и предлагает включить преобразование в новую рабочую область пакета SDK Power Query.
- Запустите рабочую область установки и задачу сборки из меню терминала. Они эффективно создают mez-файл и файлы settings.json , необходимые для рабочей области.

Добавление двух новых папок и файлов — это то, что преобразует текущую рабочую область в новую рабочую область пакета SDK Power Query.

Обновление проекта расширения до нового пакета SDK Power Query.

Настройка рабочей области

Задача настройки рабочей области фактически создает файл settings.json для рабочей области, который определяет некоторые переменные, которые будут использоваться для рабочей области, когда речь идет об оценках и общих параметрах.

Создание файла расширения

Задача сборки позволяет создать mez-файл для расширения по запросу.

Выполнение функции TestConnection

TestConnection — это функция, которая позволяет обновить соединитель в Microsoft Cloud через такие службы, как Power BI. Это запись, реализованная внутри записи источника данных соединителя. Дополнительные сведения о реализации обработчика TestConnection см. в примере, доступном для тестового подключения.

Задача запуска TestConnection позволяет протестировать обработчик в пакете SDK Power Query без необходимости вручную попробовать этот обработчик в Microsoft Cloud.

Чтобы выполнить эту задачу, сначала задайте учетные данные для соединителя, а затем выполните задачу из раздела пакета SDK Power Query в обозревателе или в списке задач в меню терминала.

Результат этой задачи отображается в выходном терминале в нижней части окна.

Результат функции Run TestConnection в пакете SDK для Power Query.

Отзывы и ошибки

Если вам нужна помощь в разработке пользовательского соединителя или наличие отзывов, предложений или ошибок, которые вы хотите сообщить, посетите наш официальный общедоступный репозиторий на сайте GitHub.

Вы также можете использовать форум Сообщество Power BI для публикации общих вопросов о Power Query, языке M и разработке настраиваемых соединителей.

Поделиться через