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

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

Note

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

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

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

Сведения об установке и настройке проверки подлинности для интерфейса командной строки Databricks см. в руководстве по Интерфейсу командной строки Databricks.

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

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

databricks -h

Чтобы вывести список команд для любой группы команд, используйте --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.

Входные и выходные данные JSON

Некоторые команды CLI Databricks имеют --json флаг или другие параметры, принимаюющие входные данные строки JSON. Кроме того, некоторые команды выводят строку JSON.

Форматирование строк

Формат строк JSON зависит от операционной системы:

Linux и macOS

Заключите параметры строк JSON в двойные кавычки и заключите весь JSON-пейлод в одинарные кавычки. Рассмотрим пример.

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

'["20230323", "Amsterdam"]'

Windows

Заключите строковые параметры и все данные JSON в двойные кавычки, а перед символами двойной кавычки внутри данных JSON ставьте обратную косую черту (\). Рассмотрим пример.

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

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

Установка полей в строке JSON

Флаг --json во многих командах позволяет задать поля объектов, которые могут быть недоступны в виде команд или параметров CLI. Например, следующий вызов добавляет пользователя с идентификатором 9ddddddd-1eee-4eee-a666-8fff7c111111 в группу с идентификатором 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux и macOS

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json '{
  "schemas": ["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
  "Operations": [
    {
      "op": "add",
      "path": "members",
      "value": [
        {
        "value": "9ddddddd-1eee-4eee-a666-8fff7c111111"
        }
      ]
    }
  ]
}'

Windows

databricks account groups patch 7eeeeeee-9ccc-4aaa-b777-1aaa2eeeee6f --json "{
  \"schemas\": [\"urn:ietf:params:scim:api:messages:2.0:PatchOp\"],
  \"Operations\": [
    {
      \"op\": \"add\",
      \"path\": \"members\",
      \"value\": [
        {
            \"value\": \"9ddddddd-1eee-4eee-a666-8fff7c111111\"
        }
      ]
    }
  ]
}"

Фильтрация выходных данных JSON с помощью jq

Для команд 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.

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

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

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

  • Last updated on