Tutorial 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.
O utilitário de interface de linha de comando Databricks (também conhecido como CLI Databricks) fornece uma interface fácil de usar para automatizar a plataforma Azure Databricks a partir de seu terminal, prompt de comando ou scripts de automação.
Este artigo demonstra como usar sua máquina de desenvolvimento local para começar rapidamente com a CLI do Databricks. Consulte O que é a CLI do Databricks?.
O seguinte tutorial prático pressupõe:
Para Linux ou macOS, você tem o Homebrew instalado.
Nota
Se você não puder usar o Homebrew, para outras maneiras de instalar a CLI, consulte Instalar ou atualizar a CLI do Databricks.
Para Windows, você tem winget, Chocolatey ou Windows Subsystem for Linux (WSL) instalado. Para obter instruções de instalação, consulte a documentação do sistema operacional.
Nota
Instalar a CLI Databricks com Chocolatey é experimental.
Se você não puder usar
winget
o , Chocolatey ou WSL para outras maneiras de instalar a CLI, consulte Instalar ou atualizar a CLI do Databricks.
Conclua os seguintes passos:
Se ainda não estiver instalado, instale a CLI do Databricks da seguinte maneira:
Linux, macOS
Use o Homebrew para instalar a CLI do Databricks executando os dois comandos a seguir:
brew tap databricks/tap brew install databricks
Windows
Você pode usar winget, Chocolatey ou Windows Subsystem for Linux (WSL) para instalar a CLI do Databricks. Se você não puder usar
winget
o , Chocolatey ou WSL, ignore este procedimento e use o Prompt de Comando ou o PowerShell para instalar a CLI do Databricks a partir do código-fonte .Nota
Instalar a CLI Databricks com Chocolatey é experimental.
Para usar
winget
para instalar a CLI do Databricks, execute os dois comandos a seguir e reinicie o prompt de comando:winget search databricks winget install Databricks.DatabricksCLI
Para usar o Chocolatey para instalar a CLI do Databricks, execute o seguinte comando:
choco install databricks-cli
Para usar o WSL para instalar a CLI do Databricks:
Instale
curl
ezip
através do WSL. Para obter mais informações, consulte a documentação do seu sistema operacional.Use o WSL para instalar a CLI do Databricks executando o seguinte comando:
curl -fsSL https://raw.githubusercontent.com/databricks/setup-cli/main/install.sh | sh
Confirme se a CLI do Databricks está instalada executando o seguinte comando, que exibe a versão atual da CLI do Databricks instalada. Esta versão deve ser 0.205.0 ou superior:
databricks -v
Nota
Se você executar
databricks
, mas receber um erro comocommand not found: databricks
, ou se você executardatabricks -v
e um número de versão de 0,18 ou abaixo estiver listado, isso significa que sua máquina não pode encontrar a versão correta do executável da CLI do Databricks. Para corrigir isso, consulte Verificar a instalação da CLI.
Depois de instalar a CLI do Databricks, conclua as seguintes etapas:
Nota
Este tutorial pressupõe que você deseja usar a autenticação de usuário para máquina (U2M) OAuth para autenticar a CLI usando sua conta de usuário do Azure Databricks. Para configurar a CLI para usar outros tipos de autenticação Databricks, consulte Autenticação para a CLI Databricks.
Use a CLI do Databricks para iniciar o gerenciamento de token OAuth localmente executando o seguinte comando para cada conta de destino ou espaço de trabalho.
Para operações no nível da conta, no comando a seguir, substitua os seguintes espaços reservados:
- Substitua
<account-console-url>
pelo Azure Databricks https://accounts.azuredatabricks.net. - Substitua
<account-id>
pela ID da sua conta do Azure Databricks. Consulte Localizar o ID da sua conta.
databricks auth login --host <account-console-url> --account-id <account-id>
Para operações no nível do espaço de trabalho, no comando a seguir, substitua
<workspace-url>
pela URL do Azure Databricks por espaço de trabalho, por exemplohttps://adb-1234567890123456.7.azuredatabricks.net
.databricks auth login --host <workspace-url>
- Substitua
A CLI do Databricks solicita que você salve as informações inseridas como um perfil de configuração do Azure Databricks. Pressione
Enter
para aceitar o nome de perfil sugerido ou digite o nome de um perfil novo ou existente. Qualquer perfil existente com o mesmo nome é substituído pelas informações que você inseriu. Você pode usar perfis para alternar rapidamente seu contexto de autenticação entre várias contas ou espaços de trabalho.Para obter uma lista de quaisquer perfis existentes, em um terminal ou prompt de comando separado, use a CLI do Databricks para executar o comando
databricks auth profiles
. Para visualizar as configurações existentes de um perfil específico, execute o comandodatabricks auth env --profile <profile-name>
.Em seu navegador da Web, conclua as instruções na tela para fazer logon em sua conta ou espaço de trabalho do Azure Databricks.
Para exibir o valor atual do token OAuth de um perfil e o carimbo de data/hora de expiração do token, execute um dos seguintes comandos:
Para operações no nível da conta, execute os seguintes comandos:
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url> --account-id <account-id>
databricks auth token --host <workspace-url> --account-id <account-id> -p <profile-name>
Se você tiver vários perfis com os mesmos
--host
valores e--account-id
, talvez seja necessário especificar as--host
opções ,--account-id
e-p
juntas para ajudar a CLI do Databricks a encontrar as informações corretas do token OAuth.Para operações no nível do espaço de trabalho, execute os seguintes comandos:
databricks auth token -p <profile-name>
databricks auth token --host <workspace-url>
databricks auth token --host <workspace-url> -p <profile-name>
Se você tiver vários perfis com os mesmos
--host
valores, talvez seja necessário especificar as--host
opções e-p
juntas para ajudar a CLI do Databricks a encontrar as informações corretas do token OAuth.
Próximos passos
Depois de configurar a CLI do Databricks:
- Para saber como usar a CLI, consulte Uso básico da CLI do Databricks.
- Para obter uma visão geral dos comandos da CLI disponíveis, consulte Comandos da CLI do Databricks.
- Se a CLI não for executada ou produzir resultados inesperados, consulte Verificar a instalação da CLI.