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.
SMA utilise un processeur de code unique qui fonctionne avec toutes les plateformes source prises en charge. Vous n’avez pas besoin de fournir d’arguments supplémentaires pour ce processeur.
Installation¶
Avant d’installer l’interface de ligne de commande (CLI), vous devez la télécharger vers un emplacement auquel vous pouvez accéder. Choisissez le guide d’installation correspondant à votre système d’exploitation :
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 | 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. |
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>
Pour installer un code d’accès à partir d’un fichier, utilisez l’option --file ou -f avec votre commande, comme suit :
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¶
Lorsque vous exécutez le processeur de code pour la première fois, vous devez fournir certains arguments. Ces arguments seront enregistrés et utilisés pour les exécutions futures. Les arguments requis sont les mêmes que ceux nécessaires lors de la création d’un nouveau projet dans l’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.
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.
Pour plus d’informations sur tous les paramètres disponibles, veuillez vous référer à ce lien.
Réalisation d’une évaluation¶
Pour réaliser une évaluation, ajoutez l’option --assessment ou -a aux commandes de conversion standard. Voici des exemples de l’aspect des commandes :
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.
Pour convertir les notebooks Jupyter, ajoutez soit l’indicateur '--enableJupyter', soit sa version abrégée '-j' à votre commande.
sma -i <input-path> -o <output-path> --enableJupyter
Définition de la valeur SQL du code source¶
Vous pouvez spécifier la syntaxe SQL à utiliser lorsqu’une commande SQL est détectée. Utilisez la commande '--sql' ou son raccourci '-f'. Les options syntaxiques prises en charge sont “SparkSql” (valeur par défaut) et “HiveSql”.
sma --input <input-path> --output <output-path> --sql SparkSql
sma --input <input-path> --output <output-path> --sql HiveSql
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
Pour en savoir plus sur l’installation d’un code d’accès, exécutez la commande sma install-access-code --help.