Uso básico da CLI do Databricks
Observação
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 disposições de Dados de Uso.
Este artigo 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?.
Este artigo pressupõe que você já instalou a CLI do Databricks e configurou a CLI para autenticação. Consulte Instalar ou atualizar a CLI do Databricks e Autenticação para a CLI do Databricks.
Listar grupos de comandos da CLI
Você lista os grupos de comando usando a opção --help ou -h. Por exemplo:
databricks -h
Listar comandos da CLI
Você lista os comandos para qualquer grupo de comandos usando 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
Você exibe a ajuda para um comando usando a opção --help ou a opção -h. Por exemplo, para exibir a ajuda para o comando clusters list:
databricks clusters list -h
Executar um comando
Informações de uso completas e sintaxe para comandos individuais podem ser encontradas na ajuda da linha de comando, mas 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
Dica
Você pode executar comandos da CLI do Databricks de dentro de um workspace do Databricks usando o terminal Da Web. O terminal da Web pode ser usado por muitos usuários em uma computação e não requer a configuração de chaves. Confira Executar comandos shell no terminal web do Azure Databricks.
Usar jq para filtrar a saída JSON
Alguns comandos da CLI do Databricks geram JSON, o que significa que você pode usar 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.
Parâmetros de cadeia de caracteres JSON
O formato dos parâmetros de cadeia de caracteres é tratado de forma diferente no JSON, dependendo do sistema operacional:
Linux ou macOS
Você deve colocar parâmetros de cadeia de caracteres JSON entre aspas duplas e deve colocar todo o conteúdo JSON entre aspas simples. Alguns exemplos:
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
Windows
Você deve colocar os parâmetros de cadeia de caracteres JSON e o inteiro payload JSON entre aspas duplas e os caracteres de aspas dentro do payload JSON devem ser precedidos por \. Alguns exemplos:
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"
Configuração do servidor proxy
Para rotear as solicitações e respostas da CLI do Databricks por um servidor proxy, defina a variável de ambiente HTTPS_PROXY no computador em que a CLI do Databricks está instalada na URL do servidor proxy.
Para definir variáveis de ambiente, confira a documentação do sistema operacional.