Uso básico da CLI do Databricks

Nota

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks, que estão em Visualização Pública. 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á tenha instalado a CLI do Databricks e configurado a CLI para autenticação. Veja:

• Instalar ou atualizar a CLI do Databricks
• Autenticação 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

Use jq para analisar a saída JSON da CLI

Algumas respostas de saída de comandos da 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 para exibição de um cluster do Azure Databricks com a ID de cluster especificada, você pode usar o utilitário jq:

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

Resultado:

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 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.

Bandeiras globais

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

Sinalizador	Description
-h ou --help	Exiba a ajuda para a CLI do Databricks ou para o grupo de comandos relacionado ou para o comando relacionado.
-e ou --environment string	Uma cadeia de caracteres que representa o ambiente de pacote a ser usado, se aplicável, para o comando relacionado.
--log-file	Uma cadeia de caracteres que representa o para gravar logs de saída. Se esse sinalizador não for especificado, o padrão é gravar logs de saída no 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 cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desativado.
-o ou --output	text para escrever saída como texto ou json para escrever saída como JSON. Se esse sinalizador não for especificado, a saída será escrita como texto.
-p ou --profile	Uma cadeia de caracteres que representa o perfil de configuração nomeado a ser usado em seu .databrickscfg arquivo. Se esse sinalizador não for especificado, o DEFAULT perfil nomeado será usado, se existir. Você pode pressionar Tab depois --profile ou -p para exibir uma lista de perfis de configuração disponíveis existentes para escolher, em vez de inserir o nome do perfil de configuração manualmente.
--progress-format	O formato para exibição de logs de progresso (default (o padrão) ou append ou inplacejson).