Базовое использование интерфейса командной строки Databricks

Note

Эта информация относится к Интерфейсу командной строки Databricks версии 0.205 и выше. Интерфейс командной строки Databricks находится в общедоступной предварительной версии.

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

В этой статье показано, как вывести список групп команд и отдельных команд Databricks CLI и команд, отобразить справку по Databricks CLI и работать с выводом Databricks CLI. См. сведения о интерфейсе командной строки Databricks?.

В этой статье предполагается, что вы уже установили интерфейс командной строки Databricks и настроили проверку подлинности для интерфейса командной строки. См. Установку или обновление Databricks CLI и аутентификация для Databricks CLI.

Перечисление групп команд CLI

Чтобы получить список доступных групп команд CLI, используйте --help или -h параметр, например:

databricks -h

Перечисление команд CLI

Чтобы вывести список команд для любой группы команд, используйте --help или -h параметр. Например, чтобы перечислить команды clusters:

databricks clusters -h

Справка по команде CLI

Чтобы отобразить информацию по использованию команды, используйте команду --help или параметр -h. Например, чтобы отобразить справку для clusters list команды:

databricks clusters list -h

Также доступен справочник команд. Смотрите команды Databricks CLI.

Выполнение команды

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

databricks <command-group> <command-name> <subcommand-name> [command-argument-value1] [--<flag1-name> <flag1-value>]

Не каждая команда имеет дополнительные подкоманда. Доступны глобальные флаги, а некоторые команды имеют дополнительные флаги. Например, следующая команда выводит доступные кластеры с помощью флага, зависяющего от команды:

databricks clusters list --can-use-client JOBS

Tip

Команды CLI Databricks можно запускать из рабочей области Databricks с помощью веб-терминала. Веб-терминал рабочей области можно использовать многими пользователями на одном вычислительном компьютере и не требует настройки проверки подлинности. См . статью "Запуск команд оболочки" в веб-терминале Azure Databricks.

Использование jq для фильтрации выходных данных JSON

Некоторые команды CLI Databricks выводит JSON, что означает, что для фильтрации выходных данных можно использовать jq . Например, чтобы указать только отображаемое имя кластера Azure Databricks с указанным идентификатором кластера:

databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name

My-11.3-LTS-Cluster

Вы можете установить jq на macOS с помощью Homebrew или brew install jq в Windows с помощью Шоколада choco install jq. См. сведения об jq в руководстве по jq.

Параметры строки JSON

Формат строковых параметров обрабатывается по-разному в формате JSON в зависимости от операционной системы:

Linux и macOS

Необходимо заключить строковые параметры JSON в двойные кавычки, и необходимо заключить всю полезные данные JSON в одинарные кавычки. Примеры:

'{"cluster_id": "1234-567890-abcde123"}'

'["20230323", "Amsterdam"]'

Windows

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

"{\"cluster_id\": \"1234-567890-abcde123\"}"

"[\"20230323\", \"Amsterdam\"]"

Конфигурация прокси-сервера

Чтобы маршрутизировать запросы и ответы Databricks через прокси-сервер, задайте HTTPS_PROXY переменную среды на компьютере, где интерфейс командной строки Databricks установлен на URL-адрес прокси-сервера.

Чтобы задать переменные среды, ознакомьтесь с документацией операционной системы.