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 Databricks CLI grupos de comando e comando, exibir Databricks CLI ajuda e trabalhar com Databricks CLI saída. Consulte O que é a CLI do Databricks?

Este artigo pressupõe que o senhor já tenha instalado o Databricks CLI e configurado o CLI para autenticação. Consulte Instalar ou atualizar a CLI da Databricks e Autenticação para a CLI da Databricks.

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

execução a comando

Informações completas sobre o uso e a sintaxe de cada comando podem ser encontradas na ajuda da linha de comando, mas Databricks CLI comando geralmente obedece à seguinte sintaxe:

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

Nem todo comando tem subcomandos adicionais. Estão disponíveis sinalizadores globais, e alguns comandos têm sinalizadores adicionais. Por exemplo, o comando a seguir mostra os clusters disponíveis, usando um sinalizador específico do comando:

databricks clusters list --can-use-client JOBS

Dica

O senhor pode executar Databricks CLI comando de dentro de um Databricks workspace usando o terminal da Web. O terminal da Web pode ser usado por vários usuários em um único compute e não requer configuração de chave. Consulte execução shell comando em Databricks web terminal.

Use jq para filtrar a saída JSON

Alguns Databricks CLI comando output JSON, o que significa que o senhor pode usar jq para filtrar o output. Por exemplo, para listar apenas o nome de exibição de um cluster Databricks com o ID de cluster especificado:

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

My-11.3-LTS-Cluster

O senhor 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 jq Manual.

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.