Uso básico da CLI do Databricks

Observação

Esta informação se aplica às versões 0.205 e acima do Databricks CLI, que estão em Public Preview. Para encontrar sua versão da CLI do Databricks, execute databricks -v.

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á instalou a CLI do Databricks e configurou a CLI para autenticação. Ver:

Listar grupos de comandos CLI

Você lista os grupos de comandos usando a opção --help ou -h . Por exemplo:

databricks -h

Listar comando CLI

Você lista o comando para qualquer grupo de comandos usando a opção --help ou -h . Por exemplo, para listar o comando clusters :

databricks clusters -h

Exibir ajuda do comando CLI

Você exibe a ajuda de um comando usando a opção --help ou -h . Por exemplo, para exibir a ajuda do comando clusters list :

databricks clusters list -h

Use `jq` para analisar a saída JSON da CLI

Algumas respostas de saída de comando CLI do Databricks são formatadas como JSON. Em muitos casos, a CLI do Databricks formata a saída JSON para que seja mais fácil de ler. No entanto, às vezes pode ser útil analisar partes do JSON em vez de listar a resposta inteira. Por exemplo, para listar apenas o nome de exibição de clusters do Databricks com o ID clusters especificado, você pode usar a utilidade jq:

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

Saída:

My-11.3-LTS-Cluster

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

Parâmetros strings JSON

O formato dos parâmetros strings é tratado de forma diferente em JSON dependendo do seu sistema operacional:

Você deve colocar os parâmetros strings JSON entre aspas duplas e toda a carga JSON entre aspas simples. Alguns exemplos:

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

'["20230323", "Amsterdam"]'

Você deve colocar os parâmetros strings 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 as solicitações e respostas da CLI da Databricks por meio de um servidor proxy, defina a variável de ambiente HTTPS_PROXY no computador em que a CLI da Databricks está instalada como o URL do servidor proxy.

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

Bandeiras globais

Os sinalizadores a seguir estão disponíveis para todos os comandos CLI do Databricks. Observe que alguns sinalizadores não se aplicam a alguns comandos. Para mais informações, consulte a documentação do comando.

Bandeira	Descrição
`-h` ou `--help`	Exibir ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.
`-e` ou `--environment string`	Uma strings que representa o ambiente do pacote configurável a ser usado, se aplicável, para o comando relacionado.
`--log-file`	Uma strings que representa a gravação de logs de saída. Se esse sinalizador não for especificado, o default será gravar logs de saída em stderr.
`--log-format`	`text` para gravar logs de saída em texto ou `json` para gravar logs de saída em JSON. Se esse sinalizador não for especificado, os logs de saída serão gravados como texto.
`--log-level`	Uma strings que representa o nível de formato logs . Se não for especificado, o nível de formato logs será desativado.
`-o` ou `--output`	`text` para gravar a saída como texto ou `json` para gravar a saída como JSON. Se este sinalizador não for especificado, a saída será escrita como texto.
`-p` ou `--profile`	Uma strings que representa o perfil de configuração nomeado a ser usado no arquivo `.databrickscfg`. Se esse sinalizador não for especificado, o perfil nomeado `DEFAULT` será usado, se existir. Você pode pressionar `Tab` após `--profile` ou `-p` para exibir uma lista de perfis de configuração existentes disponíveis para escolha, em vez de inserir o nome do perfil de configuração manualmente.
`--progress-format`	O formato para exibição logs de progresso (`default` (o default) ou `append` ou `inplace` ou `json`).