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.
O SMA usa um único processador de código que funciona com todas as plataformas de código-fonte compatíveis. Você não precisa fornecer nenhum argumento adicional para esse processador.
Instalação¶
Antes de instalar a Command Line Interface (CLI), baixe-a em um local que possa ser acessado. Escolha o guia de instalação que corresponde ao seu sistema operacional:
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.
| Long-command | Short-Command | Description |
|---|---|---|
| --help | -h | Displays help documentation. |
| --version | -v | Displays current tool version. |
| install-access-code | install-ac | Installs a new access code. |
| show-access-code | show-ac | Displays all installed access codes. |
| --input | -i | Specifies the input folder location. |
| --output | -o | Specifies the output folder location. |
| --assessment | -a | Runs the tool in assessment mode. |
| --mapDirectory | -m | Specifies the folder containing custom mapping files. |
| --enableJupyter | -j | Enables or disables conversion of Databricks notebooks to Jupyter format. |
| --sql | -f | Specifies which database engine syntax to use for SQL commands. |
| --customerEmail | -e | Sets the customer email address. |
| --customerCompany | -c | Sets the customer company name. |
| --projectName | -p | Sets the project name. |
| --yes | -y | Skips confirmation prompts during execution. |
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>
Para instalar um código de acesso a partir de um arquivo, use a opção --file ou -f com o comando, da seguinte forma:
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¶
Ao executar o processador de código pela primeira vez, você precisa fornecer alguns argumentos. Esses argumentos serão salvos e usados em execuções futuras. Os argumentos necessários são os mesmos que os necessários ao criar um novo projeto no aplicativo.
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.
.png)
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.
Para obter mais informações sobre todos os parâmetros disponíveis, consulte este link.
Realização de uma avaliação¶
Ao realizar uma avaliação, adicione a opção --assessment ou -a aos comandos de conversão padrão. Aqui estão exemplos de como os comandos devem ser:
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.
Para converter notebooks Jupyter, adicione o sinalizador '--enableJupyter' ou sua versão abreviada '-j' ao seu comando.
sma -i <input-path> -o <output-path> --enableJupyter
Definição do SQL Flavor do código-fonte¶
Você pode especificar qual sintaxe SQL deve ser usada quando um comando SQL for detectado. Use o comando '--sql' ou seu atalho '-f'. As opções de sintaxe compatíveis são “SparkSql” (que é o padrão) e “HiveSql”.
sma --input <input-path> --output <output-path> --sql SparkSql
sma --input <input-path> --output <output-path> --sql HiveSql
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
.png)
Para saber mais sobre comandos específicos, você pode executar este comando:
sma <command> --help
Para saber mais sobre a instalação de um código de acesso, execute o comando sma install-access-code --help.