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

Драйвер Databricks для SQLTools для Visual Studio Code

  • Статья

Внимание

Эта функция предоставляется в режиме общедоступной предварительной версии.

Драйвер Databricks для SQLTools позволяет использовать расширение SQLTools для Visual Studio Code для просмотра объектов SQL и выполнения запросов SQL в удаленных рабочих областях Azure Databricks.

Подготовка к работе

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

Требования к рабочей области

У вас должна быть по крайней мере одна рабочая область Azure Databricks, и рабочая область должна соответствовать следующим требованиям:

Требования к локальному компьютеру разработки

На локальном компьютере разработки необходимо иметь следующее:

Чтобы установить расширение SQLTools, перейдите к SQLTools и нажмите кнопку "Установить" или:

  1. В Visual Studio Code щелкните "Просмотреть > расширения" в главном меню.

  2. В поле "Расширения поиска" в Marketplace введите SQLTools.

  3. Щелкните запись SQLTools из Matheus Teixeira.

    Примечание.

    В списке может быть несколько записей SQLTools . Обязательно щелкните запись из Matheus Teixeira.

  4. Щелкните Установить.

Чтобы установить расширение Databricks Driver for SQLTools, перейдите к Драйверу Databricks для SQLTools и нажмите кнопку "Установить" или:

  1. В Visual Studio Code щелкните "Просмотреть > расширения" в главном меню.
  2. В поле "Расширения поиска" в Marketplace введите Databricks Driver for SQLTools.
  3. Щелкните запись Databricks Driver for SQLTools.
  4. Щелкните Установить.

Проверка подлинности

Необходимо настроить проверку подлинности для драйвера Databricks для SQLTools следующим образом.

Драйвер Databricks для SQLTools поддерживает следующие типы проверки подлинности Azure Databricks:

Примечание.

Драйвер Databricks для SQLTools не поддерживает маркеры идентификатора Microsoft Entra.

Проверка подлинности маркера личного доступа Azure Databricks

Чтобы использовать драйвер Databricks для SQLTools с проверкой подлинности маркера личного доступа Azure Databricks, необходимо иметь личный маркер доступа Azure Databricks. Чтобы создать личный маркер доступа, сделайте следующее:

  1. В рабочей области Azure Databricks щелкните имя пользователя Azure Databricks в верхней строке и выберите "Параметры " в раскрывающемся списке.
  2. Щелкните "Разработчик".
  3. Рядом с маркерами доступа нажмите кнопку "Управление".
  4. Щелкните Generate new token (Создание нового маркера).
  5. (Необязательно) Введите комментарий, который поможет определить этот маркер в будущем и изменить время существования маркера по умолчанию в течение 90 дней. Чтобы создать маркер без времени существования (не рекомендуется), оставьте поле время существования (дни) пустым (пустым).
  6. Щелкните Создать.
  7. Скопируйте отображаемый маркер в безопасное расположение и нажмите кнопку "Готово".

Примечание.

Не забудьте сохранить скопированный маркер в безопасном расположении. Не делитесь скопированным маркером с другими пользователями. Если вы потеряете скопированный маркер, вы не сможете повторно создать тот же маркер. Вместо этого необходимо повторить эту процедуру, чтобы создать новый маркер. Если вы потеряете скопированный маркер или считаете, что маркер скомпрометирован, Databricks настоятельно рекомендует немедленно удалить этот маркер из рабочей области, щелкнув значок корзины (отозвать) рядом с маркером на странице маркеров доступа.

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

Проверка подлинности компьютера на компьютере (M2M) Azure Databricks OAuth

Для проверки подлинности с помощью драйвера Databricks для SQLTools можно использовать проверку подлинности на компьютере (M2M) Azure Databricks Driver for SQLTools:

Примечание.

Проверка подлинности Azure Databricks OAuth M2M доступна в Databricks Driver for SQLTools версии 0.4.2 и выше.

  1. Выполните действия по настройке для проверки подлинности OAuth M2M. См. сведения о проверке подлинности на компьютере (M2M) OAuth.
  2. Создайте профиль конфигурации Azure Databricks с параметрами конфигурации проверки подлинности OAuth M2M. См. раздел "Конфигурация" проверки подлинности OAuth на компьютере (M2M).
  3. Установите и откройте расширение Databricks для Visual Studio Code на локальном компьютере разработки.
  4. В расширении Databricks для Visual Studio Code нажмите кнопку "Настройка " в области конфигурации . Если кнопка "Настройка" не отображается, щелкните значок шестеренки (настройка рабочей области).
  5. В палитре команд для узла Databricks введите URL-адрес Azure Databricks для каждой рабочей области, напримерhttps://adb-1234567890123456.7.azuredatabricks.net, и нажмите клавишу ВВОД.
  6. Выберите запись профиля конфигурации, соответствующую созданной на шаге 2.
  7. Выполните инструкции на экране в веб-браузере, чтобы завершить проверку подлинности с помощью учетной записи Azure Databricks.

Проверка подлинности пользователя на компьютере (U2M) Azure Databricks OAuth

Для проверки подлинности с помощью драйвера Databricks для SQLTools для проверки подлинности с помощью драйвера Databricks для SQLTools можно использовать проверку подлинности .

Примечание.

Проверка подлинности OAuth U2M Azure Databricks доступна в Databricks Driver for SQLTools версии 0.4.2 и выше.

  1. Установите и откройте расширение Databricks для Visual Studio Code на локальном компьютере разработки.
  2. В расширении Databricks для Visual Studio Code нажмите кнопку "Настройка " в области конфигурации . Если кнопка "Настройка" не отображается, щелкните значок шестеренки (настройка рабочей области).
  3. В палитре команд для узла Databricks введите URL-адрес Azure Databricks для каждой рабочей области, напримерhttps://adb-1234567890123456.7.azuredatabricks.net. Нажмите клавишу ВВОД.
  4. Выберите OAuth (пользователь на компьютер).
  5. Выполните инструкции на экране в веб-браузере, чтобы завершить проверку подлинности с помощью учетной записи Azure Databricks. Если появится запрос, разрешите all-apis доступ.

Проверка подлинности Azure CLI

Azure CLI можно использовать для проверки подлинности с помощью драйвера Databricks для SQLTools, как показано ниже.

Примечание.

Проверка подлинности с помощью Azure CLI находится в состоянии экспериментальной функции. Эта функция доступна в Databricks Driver for SQLTools версии 0.4.2 и выше.

  1. Установите Azure CLI на локальном компьютере разработки, если это еще не сделано.
  2. Установите и откройте расширение Databricks для Visual Studio Code на локальном компьютере разработки.
  3. В расширении Databricks для Visual Studio Code нажмите кнопку "Настройка " в области конфигурации . Если кнопка "Настройка" не отображается, щелкните значок шестеренки (настройка рабочей области).
  4. В палитре команд для узла Databricks введите URL-адрес Azure Databricks для каждой рабочей области, напримерhttps://adb-1234567890123456.7.azuredatabricks.net. Нажмите клавишу ВВОД.
  5. Выберите Azure CLI.
  6. Следуйте инструкциям на экране, чтобы завершить проверку подлинности с помощью Azure CLI.

Подключение к схеме

  1. В Visual Studio Code на боковой панели щелкните значок SQLTools .
  2. Если вы впервые используете расширение SQLTools, нажмите кнопку "Добавить новое подключение" в области "Подключения". В противном случае щелкните значок "Добавить новое подключение" в строке заголовка панели.
  3. На вкладке "Параметры SQLTools" на шаге "Выбор драйвера базы данных" щелкните значок Databricks.
  4. На шаге "Параметры подключения" введите следующие сведения о хранилище, каталоге и схеме:

    1. В поле "Имя подключения" введите уникальное имя для этого подключения.

    2. (Необязательно) Для группы подключений введите имя существующей группы подключений, чтобы добавить новое подключение к этой группе. Или введите уникальное имя, чтобы создать новую группу соединений с новым подключением. Группы подключений упрощают поиск подключений в расширении.

    3. Для подключения выберите один из следующих вариантов:

      • Чтобы использовать личный маркер доступа Azure Databricks для проверки подлинности, выберите имя узла и токен.
      • Для Databricks Driver for SQLTools версии 0.4.2 и выше для использования проверки подлинности OAuth U2M или M2M или Azure CLI выберите расширение VS Code (бета-версия).

    4. Если вы выбрали имя узла и токен для подключения, то для узла введите параметр имени узла хранилища. Чтобы получить параметр имени узла сервера хранилища, ознакомьтесь с сведениями о подключении для вычислительного ресурса Azure Databricks.

    5. В поле Path введите параметр HTTP-пути хранилища или кластера. Сведения о получении параметра ПУТИ HTTP хранилища см. в статье "Получение сведений о подключении для вычислительного ресурса Azure Databricks".

    6. Если вы выбрали имя узла и токен для подключения, введите значение маркера личного доступа Azure Databricks в токене.

    7. В поле "Каталог" введите имя каталога.

      Примечание.

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

    8. В поле "Схема" введите имя схемы.

    9. (Необязательно) Для параметра "Показать записи по умолчанию" оставьте значение по умолчанию 50 только для первых 50 строк для каждого запроса или введите другое ограничение.

  5. Нажмите кнопку Проверить подключение.
  6. Если тест подключения выполнен успешно, нажмите кнопку "Сохранить подключение".

Изменение параметров подключения

В этой процедуре предполагается, что вы успешно подключены к одному хранилищу.

  1. Если представление SQLTools не отображается, в Visual Studio Code на боковой панели щелкните значок SQLTools .
  2. В области "Подключения" разверните группу подключений, если она существует для целевого подключения.
  3. Щелкните правой кнопкой мыши подключение и выберите команду "Изменить подключение".
  4. Измените целевые параметры.
  5. Нажмите кнопку Проверить подключение.
  6. Если тест подключения выполнен успешно, нажмите кнопку "Сохранить подключение".

Обзор объектов схемы

  1. В области "Подключения" разверните группу подключений, если она существует для целевого подключения.
  2. Дважды щелкните или разверните целевое подключение для хранилища.
  3. Разверните целевую базу данных (схему), если она существует для подключения.
  4. Разверните таблицы или представления, если для базы данных (схема) существует одна или несколько таблиц или представлений.
  5. Разверните любую целевую таблицу или представление, чтобы просмотреть столбцы таблицы или представления.

Просмотр строк или схемы для таблицы или представления

С помощью таблиц или представлений , развернутых в области "Подключения" , выполните одно из следующих действий:

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

Создание запроса вставки для таблицы

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

Создание и запуск запроса

В этой процедуре предполагается, что вы успешно подключены к одному хранилищу.

  1. В области "Подключения" разверните группу подключений, если она существует для целевого подключения.
  2. Дважды щелкните или разверните целевое подключение для хранилища.
  3. При выбранном подключении нажмите кнопку "Создать SQL-файл " в строке заголовка области "Подключения ". Откроется новая вкладка редактора.
  4. Введите SQL-запрос в новом редакторе.
  5. Чтобы запустить SQL-запрос, нажмите кнопку "Запустить активное подключение " в редакторе. Результаты запроса отображаются на новой вкладке редактора.

Запуск существующего запроса

В этой процедуре предполагается, что вы успешно подключены к одному хранилищу.

  1. В области "Подключения" разверните группу подключений, если она существует для целевого подключения.
  2. Дважды щелкните или разверните целевое подключение для хранилища.
  3. При выбранном подключении откройте любой файл с расширением .sqlфайла или выберите любую группу непрерывных инструкций SQL в любом открывшемся ранее редакторе.
  4. Чтобы запустить SQL-запрос из открытого .sql файла, с .sql содержимым файла, отображаемого в редакторе, нажмите кнопку "Выполнить активное подключение " в редакторе. Результаты запроса отображаются на новой вкладке редактора.
  5. Чтобы запустить выбранную группу непрерывных инструкций SQL в редакторе, который ранее открылся, щелкните правой кнопкой мыши выбранный выбор и нажмите кнопку "Выполнить выбранный запрос". Результаты запроса отображаются на новой вкладке редактора.

Отправка журналов использования в Databricks

Если при использовании драйвера Databricks для SQLTools возникают проблемы, вы можете отправить журналы использования и связанные сведения в службу поддержки Databricks, выполнив следующие действия:

  1. Установите расширение Databricks для Visual Studio Code на локальном компьютере разработки.
  2. Включите ведение журнала, проверив параметр "Включенные" или "truedatabricks.logs.enabledПараметры", как описано в разделе "Параметры" расширения Databricks для Visual Studio Code, обязательно перезапустите Visual Studio Code после включения ведения журнала.
  3. Попытайтесь воспроизвести проблему.
  4. В палитре команд (представление > палитры команд из главного меню) выполните команду Databricks: откройте полные журналы.
  5. Databricks Logs.logdatabricks-cli-logs.jsonОтправьте файлы и sdk-and-extension-logs.json файлы, которые отображаются в службе поддержки Databricks.
  6. Кроме того, скопируйте содержимое терминала (просмотр терминала) в контексте проблемы и отправьте это содержимое в службу поддержки Databricks>.

В представлении вывода (просмотр > выходных данных, журналов Databricks) отображаются усеченные сведения, если журналы: включен или databricks.logs.enabled задано значение true. Чтобы отобразить дополнительные сведения, измените следующие параметры, как описано в разделе "Параметры" расширения Databricks для Visual Studio Code:

  • Журналы: максимальная длина массива или databricks.logs.maxArrayLength
  • Журналы: максимальная длина поля или databricks.logs.maxFieldLength
  • Журналы: глубина усечения или databricks.logs.truncationDepth

Дополнительные ресурсы