Uso básico da CLI do Databricks
Nota
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. Consulte O que é a CLI do Databricks?.
Este artigo pressupõe que você já tenha instalado a CLI do Databricks e configurado a CLI para autenticação. Consulte Instalar ou atualizar a CLIe a autenticação do Databricks para a CLI do Databricks.
Listar grupos de comandos da CLI
Liste os grupos de comandos usando a --help opção ou -h . Por exemplo:
databricks -h
Listar comandos da CLI
Liste os comandos para qualquer grupo de comandos usando a --help opção ou -h . Por exemplo, para listar os clusters comandos:
databricks clusters -h
Exibir ajuda do comando da CLI
Você exibe a ajuda para um comando usando a --help opção ou -h . Por exemplo, para exibir a ajuda para o clusters list comando:
databricks clusters list -h
Executar um comando
Informações completas de uso e sintaxe para comandos individuais podem ser encontradas na ajuda 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
Gorjeta
Você pode executar comandos da CLI do Databricks de dentro de um espaço de trabalho do Databricks usando o terminal da Web. O terminal Web pode ser usado por muitos usuários em um computador e não requer a configuração de chaves. Consulte Executar comandos de shell no terminal Web do Azure Databricks.
Use jq para filtrar a saída JSON
Alguns comandos da CLI do Databricks produzem JSON, o que significa que você pode usar jq para filtrar a saída. Por exemplo, para listar apenas o nome para exibição de um cluster do Azure Databricks com a ID de cluster especificada:
databricks clusters get 1234-567890-abcde123 | jq -r .cluster_name
My-11.3-LTS-Cluster
Você pode instalar jq no macOS usando Homebrew com brew install jq ou no Windows usando Chocolatey com choco install jq. Para obter mais informações sobre o jq, veja o Manual do jq.
Parâmetros da cadeia JSON
O formato dos parâmetros de cadeia de caracteres é tratado de forma diferente em JSON, dependendo do seu sistema operacional:
Linux ou macOS
Você deve colocar parâmetros de cadeia de caracteres JSON entre aspas duplas e colocar toda a carga JSON entre aspas simples. Alguns exemplos:
'{"cluster_id": "1234-567890-abcde123"}'
'["20230323", "Amsterdam"]'
Windows
Você deve incluir parâmetros de cadeia de caracteres JSON e toda a carga JSON entre aspas duplas, e os caracteres de aspas duplas dentro da carga JSON devem ser precedidos por \. Alguns exemplos:
"{\"cluster_id\": \"1234-567890-abcde123\"}"
"[\"20230323\", \"Amsterdam\"]"
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 na máquina em que a CLI do Databricks está instalada para a URL do servidor proxy.
Para definir variáveis de ambiente, consulte a documentação do seu sistema operacional.