Tutorial da CLI do Databricks

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. Consulte O que é a CLI do Databricks?.

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

Confirmar os requisitos da máquina local

Este tutorial pressupõe que:

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

  Nota

  Para outras formas de instalar a CLI se não conseguires usar Homebrew, vê Instalar ou atualizar a CLI do Databricks.

• Para Windows, você tem winget, Chocolatey ou Windows Subsystem for Linux (WSL) instalado.

  Nota

  Instalar o Databricks CLI com Chocolatey é experimental. Para outras formas de instalar a CLI, veja Instalar ou atualizar a CLI Databricks.

Instalar a CLI do Databricks

1. Instale a interface de comando 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
   

   Mac OS

   Você pode usar winget, Chocolatey ou Windows Subsystem for Linux (WSL) para instalar a CLI do Databricks. Se não conseguires usar winget Chocolatey ou WSL, deves ignorar este procedimento e deves utilizar o Prompt de Comando ou o PowerShell para instalar a Databricks CLI a partir do código fonte.

   Nota

   Instalar o Databricks CLI 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:

   1. Instale curl e zip através do WSL. Para obter mais informações, consulte a documentação do seu 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 seu espaço de trabalho Databricks.

1. 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 ao 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 ao nível do espaço de trabalho, no seguinte comando, substitua pela sua URL de Azure Databricks por espaço de trabalho, por exemplo <workspace-url>.

   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 é 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 comando databricks auth env --profile <profile-name>.

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

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

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

Próximos passos

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