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

Примечание.

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

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

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

• Установка или обновление интерфейса командной строки Databricks
• Проверка подлинности для интерфейса командной строки Databricks

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

Вы перечисляете группы команд с помощью --help или -h параметра. Например:

databricks -h

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

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

databricks clusters -h

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

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

databricks clusters list -h

Использование jq для синтаксического анализа выходных данных JSON CLI

Некоторые команды Интерфейса командной строки Databricks форматируются как JSON. Во многих случаях интерфейс командной строки Databricks форматирует выходные данные JSON, чтобы было проще читать. Однако иногда это может быть полезно для анализа частей JSON вместо перечисления всего ответа. Например, чтобы указать только отображаемое имя кластера Azure Databricks с указанным идентификатором кластера, можно использовать служебную программу jq:

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

Выходные данные:

My-11.3-LTS-Cluster

Например, в macOS можно установить jq с помощью Homebrew или brew install jq Windows с помощью Chocolatey 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-адрес прокси-сервера.

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

Глобальные флаги

Следующие флаги доступны для всех команд CLI Databricks. Обратите внимание, что некоторые флаги не применяются к некоторым командам. Дополнительные сведения см. в документации команды.

Флаг	Description
-h или --help	Отображение справки по интерфейсу командной строки Databricks или связанной группе команд или связанной команде.
-e или --environment string	Строка, представляющая среду пакета, используемую, если применимо для связанной команды.
--log-file	Строка, представляющая журналы выходных данных. Если этот флаг не указан, по умолчанию используется запись журналов выходных данных в stderr.
--log-format	text для записи журналов выходных данных в текст или json записи журналов выходных данных в JSON. Если этот флаг не указан, выходные журналы записываются как текст.
--log-level	Строка, представляющая уровень формата журнала. Если не указано, уровень формата журнала отключен.
-o или --output	text для записи выходных данных в виде текста или json записи выходных данных в формате JSON. Если этот флаг не указан, выходные данные записываются как текст.
-p или --profile	Строка, представляющая именованный профиль конфигурации для использования в .databrickscfg файле. Если этот флаг не указан, DEFAULT то именованный профиль используется, если он существует. Вы можете нажать или Tab--profile-p отобразить список существующих доступных профилей конфигурации, чтобы выбрать его вместо ввода имени профиля конфигурации вручную.
--progress-format	Формат для отображаемых журналов выполнения (defaultпо умолчанию или inplaceappendjson).