Snowpark Migration Accelerator: Usando o SMA CLI¶

Descrição¶

O Snowpark Migration Accelerator (SMA) fornece uma interface de linha de comando (CLI) que permite executar várias operações. Usando essa CLI, você pode executar o processador de código, gerenciar códigos de acesso (instalá-los ou exibi-los) e realizar qualquer outra tarefa disponível no aplicativo SMA.

The SMA uses a single code processor that works with all supported source platforms. You don’t need to provide any additional arguments for this processor.

Instalação¶

Before installing the Command Line Interface (CLI), you need to download it to a location you can access. Choose the installation guide that matches your operating system:

Comandos¶

Para executar a ferramenta, você precisa configurar uma sequência de comandos com base em suas necessidades. Você pode usar as opções long-command ou short-command com a seguinte sintaxe:

sma [command] [argument] [command] [argument] ...

Os seguintes comandos estão disponíveis. Clique em qualquer comando para ver sua explicação detalhada.


Comando longo	Comando curto	Descrição
–help	-h	Exibe a documentação de ajuda.
–version	-v	Exibe a versão atual da ferramenta.
install-access-code	install-ac	Instala um novo código de acesso.
show-access-code	show-ac	Exibe todos os códigos de acesso instalados.
–input	-i	Especifica a localização da pasta de entrada.
–output	-o	Especifica a localização da pasta de saída.
–assessment	-a	Executa a ferramenta no modo de avaliação.
–mapDirectory	-m	Especifica a pasta que contém os arquivos de mapeamento personalizados.
–enableJupyter	-j	Habilita ou desabilita a conversão de notebooks Databricks para o formato Jupyter.
–sql	-f	Especifica qual sintaxe do mecanismo de banco de dados usar para comandos SQL.
–customerEmail	-e	Define o endereço de e-mail do cliente.
–customerCompany	-c	Define o nome da empresa do cliente.
–projectName	-p	Define o nome do projeto.
–yes	-y	Ignora as solicitações de confirmação durante a execução.

Instalação de um código de acesso¶

Para iniciar o processo de conversão de código, primeiro instale um código de acesso. Você pode fazer isso de duas maneiras:

Digite o código de acesso diretamente
Forneça o caminho para um arquivo que contenha o código de acesso (esse método é útil quando estiver trabalhando off-line ou atrás de um firewall restritivo)

Você pode instalar o código de acesso executando o seguinte comando:

sma install-access-code <access-code>

Esse comando produz o mesmo resultado que o comando anterior.

sma install-ac <access-code>

To install an access code from a file, use either the --file or -f option with your command, like this:

sma install-access-code --file <path-to-file>
or
sma install-access-code -f <path-to-file>

Se ocorrer um erro durante a instalação da licença, será exibida uma mensagem de erro.

Para solicitar um código de acesso, entre em contato com sma-support@snowflake.com

Verificação de quais códigos de acesso estão instalados¶

Para verificar quais códigos de acesso estão instalados no momento em seu computador, use este comando:

sma show-access-code

Esse comando exibe detalhes sobre todos os códigos de acesso atualmente instalados no computador.

Conversão¶

Depois de instalar uma licença válida, você pode executar o processador de código para converter seu código. Para iniciar o processo de conversão, você precisa fornecer os seguintes argumentos necessários:

Caminho de entrada: A pasta que contém seu código-fonte original
Caminho de saída: A pasta onde deseja que o código convertido seja salvo

Informações sobre o projeto¶

When you run the code processor for the first time, you need to provide certain arguments. These arguments will be saved and used for future executions. The required arguments are the same as those needed when creating a new project in the application.

E-mail do cliente: Digite um endereço de e-mail válido
Empresa do cliente: Digite o nome de sua empresa
Nome do projeto: Digite um nome para seu projeto

Este exemplo demonstra como executar o processador de código usando apenas os requisitos essenciais:

sma -i <input-path> -o <output-path> -e <client email> -c <client company> -p <project name> <additional-parameters>

Após digitar a sequência de comandos e pressionar «Enter», a ferramenta exibirá as configurações atuais e solicitará que você confirme antes de iniciar o processo.

Configuração atual antes de iniciar o processo.

Gostaria de acrescentar ou modificar algum argumento? Digite «n» para cancelar ou «y» para continuar.

Ignorar a confirmação do projeto¶

Para ignorar o prompt de confirmação mostrado acima, adicione –yes ou -y como argumento. Isso é particularmente importante ao usar a ferramenta de forma programática, pois o prompt de confirmação será exibido todas as vezes sem esses parâmetros.

For more information about all available parameters, please refer to this link.

Realização de uma avaliação¶

When performing an assessment, add the --assessment or -a option to the standard conversion commands. Here are examples of how the commands should look:

sma --input <input-path> --output <output-path> --assessment <additional-parameters>

Cada um desses comandos pode aceitar parâmetros adicionais. Para obter mais detalhes, consulte a seção «Conversão».

Verificação da versão da ferramenta¶

Para verificar a versão da ferramenta e o mecanismo de processamento de código, você pode usar qualquer um desses comandos:

sma --version
sma -v

Habilitando a conversão de notebooks do Databricks para Jupyter Notebooks¶

Essa opção converte arquivos de origem Python (.python) e/ou Scala (.scala) em arquivos Jupyter Notebook (.ipynb). A conversão funciona independentemente de os arquivos originais terem sido exportados de notebooks ou de serem arquivos de código regulares.

To convert Jupyter notebooks, add either the '--enableJupyter' flag or its shorthand version '-j' to your command.

sma -i <input-path> -o <output-path> --enableJupyter

Definição do SQL Flavor do código-fonte¶

You can specify which SQL syntax to use when a SQL command is detected. Use either the command '--sql' or its shortcut '-f'. The supported syntax options are “SparkSql” (which is the default), “HiveSql”, and “Databricks”.

sma --input <input-path> --output <output-path> --sql SparkSql
sma --input <input-path> --output <output-path> --sql HiveSql
sma --input <input-path> --output <output-path> --sql Databricks

Você precisa de mais ajuda?¶

Para visualizar as informações gerais de ajuda da Command Line Interface (CLI), você pode usar qualquer um desses comandos:

sma --help
sma -h

Para saber mais sobre comandos específicos, você pode executar este comando:

sma <command> --help

To learn more about installing an access code, run the command sma install-access-code --help.