Uso básico da CLI do Databricks

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

Esta página mostra como listar grupos de comandos e comandos da CLI do Databricks, exibir a ajuda da CLI do Databricks e trabalhar com a saída da CLI do Databricks. Confira O que é a CLI do Databricks?.

Para instalar e configurar a autenticação para a CLI do Databricks, consulte o tutorial da CLI do Databricks.

Listar comandos da CLI disponíveis

Para listar os grupos de comandos da CLI disponíveis, use a opção --help ou -h, por exemplo:

databricks -h

Para listar os comandos de qualquer grupo de comandos, use a opção --help ou a opção -h. Por exemplo, para listar os comandos clusters:

databricks clusters -h

Exibir a ajuda do subcomando da CLI

Para exibir informações de uso de um comando, use a opção --help ou a opção -h com o comando. Por exemplo, para exibir a ajuda para o comando clusters list:

databricks clusters list -h

A referência de comando também está disponível. Consulte Comandos da CLI do Databricks.

Executar um comando

Informações de uso completas e sintaxe para comandos individuais podem ser encontradas na ajuda e referência da linha de comando, mas os comandos da CLI do Databricks geralmente estão em conformidade com a seguinte sintaxe:

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

Nem todos os comandos têm subcomandos adicionais. Sinalizadores globais estão disponíveis e alguns comandos têm sinalizadores adicionais. Por exemplo, o comando a seguir gera clusters disponíveis usando um sinalizador específico de comando:

databricks clusters list --can-use-client JOBS

Tip

Você pode executar comandos da CLI do Databricks de dentro de um workspace do Databricks usando o terminal Da Web. O terminal Web do workspace pode ser usado por muitos usuários em uma computação e não exige que você configure a autenticação. Confira Executar comandos shell no terminal web do Azure Databricks.

Entrada e saída JSON

Alguns comandos da CLI do Databricks têm um --json sinalizador ou outras opções que aceitam entrada de cadeia de caracteres JSON. Além disso, alguns comandos geram uma cadeia de caracteres JSON.

Formatação da cadeia de caracteres

O formato das cadeias de caracteres JSON depende do sistema operacional:

Linux ou macOS

Coloque os parâmetros de cadeia de caracteres JSON entre aspas duplas e coloque o conteúdo JSON inteiro entre aspas simples. Por exemplo:

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

'["20230323", "Amsterdam"]'

Windows

Coloque os parâmetros de cadeia de caracteres JSON e toda a carga JSON entre aspas duplas e preceda os caracteres de aspas duplas dentro do conteúdo JSON com uma barra invertida (\). Por exemplo:

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

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

Definir campos em uma cadeia de caracteres JSON

O --json sinalizador em muitos comandos permite que você defina campos de objeto que podem não estar disponíveis como comandos ou opções da CLI. Por exemplo, a chamada a seguir adiciona um usuário com a ID 9ddddddd-1eee-4eee-a666-8fff7c111111 ao grupo com a ID 7eeeeeee-9ccc-4aaa-b777-1aaaaaaaaaa:

Linux ou 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\"
        }
      ]
    }
  ]
}"

Filtrar a saída JSON com jq

Para comandos da CLI do Databricks que geram JSON, você pode usar o processador de linha de comando jq para filtrar a saída. Por exemplo, para listar apenas o nome de exibição de um cluster do Azure Databricks com a ID do cluster especificada:

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

My-11.3-LTS-Cluster

Você pode instalar jq no macOS usando o Homebrew com brew install jq ou no Windows usando o Chocolatey com choco install jq. Para obter mais informações sobre jq, consulte o Manual jq.

Configuração do servidor proxy

Para rotear solicitações e respostas da CLI do Databricks por meio de um servidor proxy, defina a HTTPS_PROXY variável de ambiente no computador em que a CLI do Databricks está instalada na URL do servidor proxy.

Para definir variáveis de ambiente, consulte a documentação do sistema operacional.