Snowpark Migration Accelerator : Utilisation de l’interface CLI SMA¶

Description¶

Snowpark Migration Accelerator (SMA) fournit une interface de ligne de commande (CLI) qui vous permet d’effectuer diverses opérations. En utilisant cette CLI, vous pouvez exécuter le processeur de code, gérer les codes d’accès (les installer ou les afficher) et effectuer toute autre tâche disponible dans l’application 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.

Installation¶

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:

Commandes¶

Pour utiliser l’outil, vous devez configurer une séquence de commandes en fonction de vos exigences. Vous pouvez utiliser les options long-command ou short-command avec la syntaxe suivante :

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

Les commandes suivantes sont disponibles. Cliquez sur n’importe quelle commande pour voir son explication détaillée.


Long-command	Short-Command	Description
–help	-h	Affiche la documentation d’aide.
–version	-v	Affiche la version actuelle de l’outil.
install-access-code	install-ac	Installe un nouveau code d’accès.
show-access-code	show-ac	Affiche tous les codes d’accès installés.
–input	-i	Spécifie l’emplacement du dossier d’entrée.
–output	-o	Spécifie l’emplacement du dossier de sortie.
–assessment	-a	Exécute l’outil en mode d’évaluation.
–mapDirectory	-m	Spécifie le dossier contenant les fichiers de mappage personnalisés.
–enableJupyter	-j	Active ou désactive la conversion des notebooks Databricks au format Jupyter.
–sql	-f	Spécifie la syntaxe du moteur de base de données à utiliser pour les commandes SQL.
–customerEmail	-e	Définit l’adresse e-mail du client.
–customerCompany	-c	Définit le nom de l’entreprise cliente.
–projectName	-p	Définit le nom du projet.
–yes	-y	Ignore les invites de confirmation pendant l’exécution.

Installation d’un code d’accès¶

Pour commencer le processus de conversion des codes, vous devez d’abord installer un code d’accès. Vous pouvez le faire de deux manières :

Saisissez directement le code d’accès
Fournissez le chemin d’accès à un fichier contenant le code d’accès (cette méthode est utile lorsque vous travaillez hors ligne ou derrière un pare-feu restrictif)

Vous pouvez installer le code d’accès en exécutant la commande suivante :

sma install-access-code <access-code>

Cette commande produit le même résultat que la commande précédente.

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>

Si une erreur se produit lors de l’installation de la licence, un message d’erreur s’affiche.

Pour demander un code d’accès, veuillez contacter sma-support@snowflake.com

Vérification des codes d’accès installés¶

Pour vérifier quels sont les codes d’accès actuellement installés sur votre ordinateur, utilisez cette commande :

sma show-access-code

Cette commande permet d’afficher les détails de tous les codes d’accès actuellement installés sur votre ordinateur.

Conversion¶

Après avoir installé une licence valide, vous pouvez exécuter le processeur de code pour convertir votre code. Pour lancer le processus de conversion, vous devez fournir les arguments requis suivants :

Chemin d’entrée : Le dossier contenant votre code source original
Chemin de sortie : Le dossier dans lequel vous souhaitez que le code converti soit enregistré

Information sur le projet¶

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 du client : Saisissez une adresse e-mail valide
Société du client : Saisissez le nom de votre entreprise
Nom du projet : Saisissez un nom pour votre projet

Cet exemple montre comment exécuter le processeur de code en utilisant uniquement les exigences essentielles :

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

Après avoir saisi la séquence de commandes et appuyé sur « Entrée », l’outil affichera vos paramètres actuels et vous demandera de confirmer avant de lancer le processus.

Configuration actuelle avant le début du processus.

Souhaitez-vous ajouter ou modifier des arguments ? Saisissez « n » pour annuler ou « y » pour continuer.

Ignorer la confirmation du projet¶

Pour contourner la demande de confirmation affichée ci-dessus, ajoutez –yes ou -y comme argument. Ceci est particulièrement important lorsque vous utilisez l’outil de manière programmatique, car la demande de confirmation s’affichera à chaque fois sans ces paramètres.

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

Réalisation d’une évaluation¶

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>

Chacune de ces commandes peut accepter des paramètres supplémentaires. Pour plus de références, veuillez vous reporter à la section « Conversion ».

Vérification de la version de l’outil¶

Pour vérifier la version de l’outil et le moteur de traitement du code, vous pouvez utiliser l’une des commandes suivantes :

sma --version
sma -v

Activation de la conversion de notebooks Databricks en notebooks Jupyter¶

Cette option convertit les fichiers source Python (.python) et/ou Scala (.scala) en fichiers Jupyter Notebook (.ipynb). La conversion fonctionne indépendamment du fait que les fichiers originaux aient été exportés à partir de notebooks ou qu’il s’agisse de fichiers de code ordinaires.

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

Définition de la valeur SQL du code source¶

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

Besoin d’aide ?¶

Pour voir les informations générales d’aide pour l’interface de ligne de commande (CLI), vous pouvez utiliser l’une des commandes suivantes :

sma --help
sma -h

Pour en savoir plus sur des commandes spécifiques, vous pouvez exécuter cette commande :

sma <command> --help

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