Tutorial da CLI do Databricks

O utilitário de interface de linha de comando do Databricks (também conhecido como a CLI do Databricks) fornece uma interface fácil de usar para automatizar a plataforma do Azure Databricks de seu terminal, prompt de comando ou scripts de automação. Veja O que é a CLI do Databricks?.

Este artigo demonstra como instalar e configurar rapidamente a CLI do Databricks.

Confirmar os requisitos do computador local

Este tutorial pressupõe que:

• Para Linux ou macOS, você tem o Homebrew instalado.

  Observação

  Para obter outras maneiras de instalar a CLI se você não puder usar o Homebrew, consulte Instalar ou atualizar a CLI do Databricks.

• Para o Windows, você tem o winget, o Chocolatey ou o Subsistema do Windows para Linux (WSL) instalado.

  Observação

  Instalar a CLI do Databricks com Chocolatey é considerada Experimental. Para obter outras maneiras de instalar a CLI, consulte Instalar ou atualizar a CLI do Databricks.

Instalar a CLI do Databricks

1. Instale o CLI do Databricks:

   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 o winget, o Chocolatey ou o Subsistema do Windows para Linux (WSL) para instalar a CLI do Databricks. Se você não puder usar o winget, WSL ou o Chocolatey, ignore este procedimento e use o Prompt de Comando ou o PowerShell para instalar a CLI do Databricks a partir da origem.

   Observação

   Instalar a CLI do Databricks com Chocolatey é considerada 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:

   1. Instale curl e zip por meio do WSL. Para obter mais informações, consulte a documentação do sistema operacional.

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

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

Configurar o acesso ao seu espaço de trabalho

Em seguida, configure o acesso ao workspace do Databricks.

1. Use a CLI do Databricks para iniciar o gerenciamento de token OAuth localmente executando o comando a seguir para cada conta de destino ou workspace.

   Para operações em nível de conta, no comando a seguir, substitua os seguintes espaços reservados:

   • Substitua <account-console-url> pelo https://accounts.azuredatabricks.net do Azure Databricks.
   • Substitua <account-id> pela ID da conta do Azure Databricks. Confira Localizar a ID da 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 por espaço de trabalho do Azure Databricks, por exemplo https://adb-1234567890123456.7.azuredatabricks.net.

   databricks auth login --host <workspace-url>
   

2. 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 será substituído pelas informações inseridas. Você pode usar perfis para alternar rapidamente o contexto de autenticação entre várias contas ou workspaces.

   Para obter uma lista dos perfis existentes, em um terminal ou prompt de comando separado, use a CLI do Databricks para executar o comando databricks auth profiles. Para exibir as configurações existentes de um perfil específico, execute o comando databricks auth env --profile <profile-name>.

3. No seu navegador da Web, conclua as instruções na tela para fazer logon em sua conta ou workspace do Azure Databricks.

4. 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 em nível de 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 valores de --host e --account-id, talvez seja necessário especificar as opções --host, --account-id e -p para ajudar a CLI do Databricks a encontrar as informações corretas do token OAuth correspondentes.

   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 tiver vários perfis com os mesmos valores --host, poderá ter de especificar as opções --host e -p em conjunto para ajudar a CLI do Databricks a encontrar as informações do token OAuth correspondentes corretas.

Próximas etapas

• Para saber como usar a CLI, confira Uso básico da CLI do Databricks.
• Para obter uma visão geral dos comandos disponíveis da CLI, consulte os Comandos da CLI do Databricks.
• Se a CLI não executar ou produzir resultados inesperados, confira Verificar a instalação da CLI.