Migração da CLI da Databricks
Este artigo descreve como migrar de Databricks CLI versão 0.18 ou abaixo para Databricks CLI versão 0.205 ou acima. Databricks CLI As versões 0.205 e acima estão em Public Preview.
Para fins de brevidade, este artigo se refere a Databricks CLI versões 0.18 e abaixo como o "legado" CLI, e Databricks CLI versões 0.205 e acima como o "novo" CLI.
Para obter mais informações sobre o legado e as novas CLIs, consulte:
- Databricks CLI (legacy) para a CLI legada.
- O que é a CLI da Databricks? para a nova CLI.
Desinstalar a CLI herdada
Se o senhor tiver o CLI legado instalado e quiser desinstalá-lo, use pip (ou pip3, dependendo da sua versão do Python) para executar o comando uninstall, como segue:
pip uninstall databricks-cli
Instalar a nova CLI
Para saber como instalar a nova CLI, consulte Instalar ou atualizar a CLI da Databricks.
Verifique a instalação da CLI
Se não tiver certeza de que está usando a nova CLI, siga as instruções desta seção para verificar e ajustar conforme necessário. Antes de seguir estas instruções, certifique-se de sair de qualquer ambiente virtual Python, conda ou ambientes semelhantes.
Para verificar a versão de sua instalação do default do CLI, execute o seguinte comando:
databricks -v
Se o número da versão não for o esperado, faça o seguinte:
- Se quiser usar apenas uma versão da CLI : desinstale todas as versões anteriores da CLI que não deseja mais usar. Talvez seja necessário atualizar o site
PATHdo seu sistema operacional para que o caminho para a versão restante da CLI que o senhor deseja usar seja listado. - Se quiser continuar usando várias versões da CLI : acrescente o caminho completo da versão da CLI que deseja usar a cada chamada à CLI.
- Se quiser continuar usando várias versões da CLI, mas não quiser continuar anexando o caminho completo à versão da CLI que você usa com mais frequência : certifique-se de que o caminho completo para essa versão esteja listado primeiro no site
PATHdo sistema operacional. Observe que o senhor ainda deve acrescentar o caminho completo às versões da CLI que não estão listadas em primeiro lugar no sitePATHdo seu sistema operacional.
Para atualizar o PATH do seu sistema operacional, faça o seguinte:
- MacOS or Linux
- Windows
-
List the paths where
databricksis installed by running one of the following commands:Bashwhich -a databricks
# Or:
where databricks -
Get the path to the installation that you want to use without prepending the full path to each and every call to the CLI. If you are not sure which path this is, run the full path to each location, followed by
-v, for example:Bash/usr/local/bin/databricks -v -
To put the path to the installation that you want to use first in your
PATH, run the following command, replacing/usr/local/binwith the path that you want to use. Do not adddatabricksto the end of this path. For example:Bashexport PATH="/usr/local/bin:$PATH" -
To verify that the
PATHwas set correctly for the current terminal session, rundatabricksfollowed by-vand check the version number:Bashdatabricks -v -
To have the
PATHset this way every time you restart your terminal, add the command from step 3 to your shell initialization file. For example, for Zshell, this file is typically located at~/.zshrc. For Bash, this file is typically located at~/.bashrc. For other shells, see your shell provider’s documentation. -
After you update your shell initialization file, you must restart your terminal to apply the updated
PATHvalue.
-
Right-click the installation of
databricksthat you want to use without prepending the full path to each and every call to the CLI. -
Click Open file location.
-
Note the path to
databricks, for exampleC:\Windows. -
On the Start menu, search for Environment variables.
-
Click Edit environment variables for your account.
-
Select the Path variable in the User variables for
<username>section. -
Click Edit.
-
Click New.
-
Enter the path that you want to add, without
databricks.exe(such asC:\Windows). -
Use the Move Up button to move the path that you just added to the beginning of the list.
-
Click OK.
-
To verify that the
PATHwas set correctly, open a new Command Prompt, rundatabricksfollowed by-v, and check the version number:Bashdatabricks -v
Use tipos de autenticação adicionais
O legado CLI e o novo CLI suportam a autenticação de tokens de acesso pessoal Databricks. No entanto, a Databricks recomenda que o senhor use outros tipos de autenticação da Databricks, se possível, que somente a nova CLI suporta.
Se for necessário usar a autenticação de tokens de acesso pessoal Databricks, a Databricks recomenda que o senhor use um token associado a uma entidade de serviço em vez de um usuário Databricks account ou workspace. Consulte gerenciar entidade de serviço.
A nova CLI oferece suporte a tokens OAuth, além dos tokens de acesso pessoal da Databricks. Esses tokens adicionais são mais seguros, pois normalmente expiram em uma hora, enquanto os tokens de acesso pessoal da Databricks podem ser válidos de um dia até indefinidamente. Isso é especialmente importante se um token for acidentalmente verificado nos sistemas de controle de versão que podem ser acessados por outras pessoas. Além disso, o novo CLI pode automaticamente refresh esses tokens adicionais quando expirarem, enquanto a atualização do Databricks acesso pessoal tokens é um processo manual ou pode ser difícil de automatizar.
Para obter mais informações, consulte Autenticação para o site Databricks CLI .
grupo de comando e comparações de comando
A tabela a seguir lista os grupos de comando legados CLI e seus novos equivalentes de grupo de comando CLI. Nos casos em que existem diferenças significativas entre as CLIs, tabelas adicionais listam o comando ou as opções do legado CLI e seus equivalentes no novo comando ou opção CLI.
Grupos de comando
Grupo de comando legado | Novo grupo de comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| Não está disponível na nova CLI. A Databricks recomenda que, em vez disso, o senhor use o provedor Databricks Terraform. |
|
|
| Diversos. Consulte |
|
|
Opçõesconfigure
Opção legada | Nova opção |
|---|---|
| A CLI herdada usa |
| Para o OAuth na nova CLI, consulte Autenticação de credenciais do Google Cloud ou Autenticação de ID do Google Cloud. |
| Para o OAuth na nova CLI, consulte Autenticação de credenciais do Google Cloud ou Autenticação de ID do Google Cloud. |
|
|
| Não está disponível na nova CLI. |
|
|
| Use |
| Não está disponível na nova CLI. |
| Não está disponível na nova CLI. A nova CLI usa apenas a API 2.1 do Jobs. Para chamar a API 2.0 de Jobs herdada, use a CLI herdada e consulte CLI da Databricks (herdada). |
| Para depuração e registro na nova CLI, consulte Modo de depuração. |
|
|
|
|
fs comando
Todos os fs comandos no legado CLI são os mesmos no novo CLI, exceto fs mv que não está disponível no novo CLI.
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
| Não está disponível na nova CLI. |
|
|
groups comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
pipelines comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
runs comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
secrets comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
tokens comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
unity-catalog grupos de comando
unity-catalog <command> na CLI antiga se torna apenas <command> na nova CLI.
Grupo de comando legado | Novo grupo de comando |
|---|---|
|
|
|
|
| Não está disponível na nova CLI. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
workspace comando
Comando Legacy | Novo comando |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
argumentos padrão e posicionais
A maioria dos novos CLI comando tem pelo menos um argumento default que não tem uma opção de acompanhamento. Alguns dos novos CLI comandos têm dois ou mais argumentos posicionais que devem ser especificados em uma ordem específica e que não têm opções de acompanhamento. Isso é diferente do legado CLI, em que a maioria dos comandos exige que as opções sejam especificadas para todos os argumentos. Por exemplo, o novo comando CLI's clusters get usa um ID de clustering como argumento default. No entanto, o comando clusers get do CLIlegado exige que o senhor especifique uma opção --cluster-id junto com o ID do clustering. Por exemplo:
Para a CLI herdada:
# This works with the legacy CLI.
databricks clusters get --cluster-id 1234-567890-a1b23c4d
# This does **not** work with the legacy CLI - "Error:
# Missing None. One of ['cluster-id', 'cluster-name'] must be provided."
databricks clusters get 1234-567890-a1b23c4d
Para a nova CLI:
# This works with the new CLI.
databricks clusters get 1234-567890-a1b23c4d
# This does **not** work with the new CLI - "Error: unknown flag: --cluster-id"
databricks clusters get --cluster-id 1234-567890-a1b23c4d
Como outro exemplo, o novo comando CLI's grants get recebe dois argumentos default: o tipo de securizável seguido do nome completo do securizável. No entanto, o comando unity-catalog permissions get da CLI herdada exige que o senhor especifique uma opção --<securable-type> juntamente com o nome completo do securizável. Por exemplo:
Para a CLI herdada:
databricks unity-catalog permissions get --schema main.default
Para a nova CLI:
# This works with the new CLI.
databricks grants get schema main.default
# This does **not** work with the new CLI - "Error: unknown flag: --schema"
databricks grants get --schema main.default
Modo de depuração
A CLI legada fornece uma opção --debug para mostrar o rastreamento completo da pilha em caso de erro. Na nova CLI, a opção --debug não é reconhecida. Em vez disso, use as seguintes opções:
- Use
--log-file <path>para gravar log informações no arquivo especificado em<path>. Se essa opção não for fornecida, log informações serão enviadas para stderr. Especificar--log-filesem especificar também--log-levelresulta em nenhuma log informação sendo gravada no arquivo. - Use
--log-format <type>para especificar o formato dos registros de informações.<type>pode sertext(o default, se não for especificado) oujson. - Use
--log-level <format>para especificar o nível dos registros de informações. Os valores permitidos sãodisabled(o default, se não for especificado),trace,debug,info,warneerror.
Para a CLI herdada, o exemplo a seguir mostra o rastreamento completo da pilha em caso de erro:
databricks fs ls / --debug
# Output:
#
# HTTP debugging enabled
# NoneType: None
# Error: The path / must start with "dbfs:/"
Para o novo CLI, o exemplo a seguir logs o rastreamento completo da pilha em um arquivo chamado new-cli-errors.log no diretório de trabalho atual. O rastreamento de pilha é gravado no arquivo no formato JSON:
databricks fs ls / --log-file new-cli-errors.log --log-format json --log-level trace
# Output:
#
# Error: expected dbfs path (with the dbfs:/ prefix): /
#
# (The full stack trace is also written to the new-cli-errors.log file.)
Perguntas comuns
Esta seção lista perguntas comuns sobre a migração da CLI antiga para a nova.
O que está acontecendo com a CLI herdada?
A CLI legada ainda está disponível, mas não está recebendo nenhuma atualização não crítica. A documentação da CLI herdada reflete isso. A Databricks recomenda que os usuários migrem para a nova CLI o mais rápido possível.
O legado CLI sempre esteve em um estado Experimental com um aviso de que Databricks não planeja nenhum novo trabalho de recurso para o legado CLI, e o legado CLI não é suportado pelo canal de suporte Databricks.
Quando a CLI legada será descontinuada?
O legado CLI sempre esteve em um estado Experimental com um aviso de que Databricks não planeja nenhum novo trabalho de recurso para o legado CLI, e o legado CLI não é suportado pelo canal de suporte Databricks.
A Databricks não estabeleceu uma data ou cronograma para a descontinuação da CLI herdada. No entanto, a Databricks recomenda que os usuários migrem para a nova CLI o mais rápido possível.
Quando a nova CLI será lançada como disponível de forma geral (GA)?
Não foi estabelecida uma data de lançamento ou um cronograma para o lançamento da nova CLI como GA. Isso dependerá do feedback que a Databricks receber dos usuários durante a visualização pública.
Quais são as diferenças key entre a CLI antiga e a nova?
- A CLI legada foi lançada como um pacote Python. A nova CLI é lançada como um executável autônomo e não precisa de nenhuma dependência de tempo de execução instalada.
- A nova CLI tem cobertura completa das APIs REST da Databricks. A CLI herdada não faz isso.
- A nova CLI está disponível como uma visualização pública. A CLI legada permanece em um estado Experimental.
O novo CLI tem paridade total de recurso com o legado CLI?
O novo CLI tem cobertura para quase todo o comando do legado CLI. No entanto, notavelmente ausente do novo CLI está o grupo de comando stacks no legado CLI. Além disso, alguns grupos de comando legados do CLI, como unity-catalog e runs, foram refatorados em novos grupos de comando no novo CLI. Para obter orientações sobre migração, consulte as informações fornecidas anteriormente neste artigo.
Como faço para migrar da CLI antiga para a nova?
Para obter orientações sobre migração, consulte as informações fornecidas anteriormente neste artigo. Observe que a nova CLI não é um substituto imediato da CLI antiga e requer alguma configuração para passar da CLI antiga para a nova.
As instalações das CLIs antigas e novas podem existir na mesma máquina?
Sim. As instalações das CLIs antigas e novas podem existir na mesma máquina, mas devem estar localizadas em diretórios diferentes. Como os executáveis são ambos denominados databricks, o senhor deve controlar qual executável é executado por default configurando o PATH da sua máquina. CLI CLI Se default o senhor quiser executar o novo, mas, de alguma forma, acidentalmente executar o legado,CLI o legado executará o novo CLI com os mesmos argumentos e mostrará a seguinte mensagem de aviso:
Databricks CLI <new-version-number> found at <new-path>
Your current PATH prefers running CLI <old-version-number> at <old-path>
Because both are installed and available in PATH,
I assume you are trying to run the newer version.
If you want to disable this behavior you can set DATABRICKS_CLI_DO_NOT_EXECUTE_NEWER_VERSION=1.
Executing CLI <new-version-number>...
-------------------------------------
Databricks CLI <new-version-number>
Conforme mostrado na mensagem de aviso anterior, o senhor pode definir a variável de ambiente DATABRICKS_CLI_DO_NOT_EXECUTE_NEWER_VERSION como 1 para desativar esse comportamento e, em vez disso, executar o site legado CLI.
Obtenha ajuda
Para obter ajuda na migração do site legado CLI para o novo CLI, consulte o recurso a seguir: