Compartilhar via

Tutorial da CLI do Databricks

  • Artigo

Observação

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

Este artigo demonstra como usar seu computador de desenvolvimento local para começar rapidamente a usar a CLI do Databricks. Veja O que é a CLI do Databricks?.

O tutorial prático a seguir pressupõe que você tenha um computador com acesso à internet:

Conclua as seguintes etapas:

  1. Se ela ainda não estiver instalada, instale a CLI do Databricksda 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 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 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

    Observação

    Se você executar databricks, mas receber um erro como command not found: databricks, ou se você executar databricks -v e um número de versão 0.18 ou inferior estiver listado, isso significa que seu computador não poderá encontrar a versão correta do executável da CLI do Databricks. Para corrigir isso, confira: Verificar sua instalação da CLI.

Depois de instalar a CLI do Databricks, conclua as seguintes etapas:

Observação

Este tutorial pressupõe que você deseja usar a autenticação U2M (usuário para máquina) do 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 do Databricks, confira Autenticação para a CLI 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:

    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 comandos a seguir:

    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

Depois de configurar a CLI do Databricks: