Snowpark Migration Accelerator: Die Verwendung von SMA CLI¶

Beschreibung¶

Der Snowpark Migration Accelerator (SMA) bietet eine Befehlszeilenschnittstelle (CLI ), über die Sie verschiedene Operationen durchführen können. Über diese CLI können Sie den Codeprozessor ausführen, Zugangscodes verwalten (installieren oder anzeigen) und alle anderen Aufgaben ausführen, die in der SMA-Anwendung verfügbar sind.

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:

Befehle¶

Um das Tool auszuführen, müssen Sie eine Reihe von Befehlen einrichten, die Ihren Anforderungen entsprechen. Sie können entweder die Optionen long-command oder short-command mit der folgenden Syntax verwenden:

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

Die folgenden Befehle sind verfügbar. Klicken Sie auf einen beliebigen Befehl, um seine detaillierte Erklärung anzuzeigen.


Lang-Befehl	Kurz-Befehl	Beschreibung
–help	-h	Zeigt die Hilfedokumentation an.
–version	-v	Zeigt die aktuelle Tool-Version an.
install-access-code	install-ac	Installiert einen neuen Zugangscode.
show-access-code	show-ac	Zeigt alle installierten Zugangscodes an.
–input	-i	Gibt den Speicherort des Eingabeordners an.
–output	-o	Gibt den Speicherort des Ausgabeordners an.
–assessment	-a	Führt das Tool im Bewertungsmodus aus.
–mapDirectory	-m	Gibt den Ordner an, der die kundenspezifischen Zuordnungsdateien enthält.
–enableJupyter	-j	Aktiviert oder deaktiviert die Konvertierung von Databricks-Notebooks in das Jupyter-Format.
–sql	-f	Gibt an, welche Syntax der Datenbank-Engine für SQL-Befehle verwendet werden soll.
–customerEmail	-e	Legt die E-Mail-Adresse der Kundschaft fest.
–customerCompany	-c	Legt den Firmennamen der Kundschaft fest.
–projectName	-p	Legt den Projektnamen fest.
–yes	-y	Überspringt Bestätigungsaufforderungen während der Ausführung.

Installieren eines Zugangscodes¶

Um die Codekonvertierung zu beginnen, müssen Sie zunächst einen Zugangscode installieren. Sie können dies auf zwei Arten tun:

Geben Sie den Zugangscode direkt ein
Geben Sie den Pfad zu einer Datei an, die den Zugangscode enthält (Diese Methode ist hilfreich, wenn Sie offline oder hinter einer restriktiven Firewall arbeiten)

Sie können den Zugangscode installieren, indem Sie den folgenden Befehl ausführen:

sma install-access-code <access-code>

Dieser Befehl liefert das gleiche Ergebnis wie der vorherige Befehl.

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>

Wenn bei der Installation der Lizenz ein Fehler auftritt, wird eine Fehlermeldung angezeigt.

Um einen Zugangscode anzufordern, wenden Sie sich bitte an sma-support@snowflake.com

Überprüfen, welche Zugangscodes installiert sind¶

Um zu überprüfen, welche Zugangscodes derzeit auf Ihrem Computer installiert sind, verwenden Sie diesen Befehl:

sma show-access-code

Dieser Befehl zeigt Details zu allen Zugangscodes an, die derzeit auf Ihrem Computer installiert sind.

Konvertieren¶

Nachdem Sie eine gültige Lizenz installiert haben, können Sie den Codeprozessor ausführen, um Ihren Code zu konvertieren. Um den Konvertierungsprozess zu starten, müssen Sie die folgenden erforderlichen Argumente angeben:

Eingabepfad: Der Ordner mit Ihrem ursprünglichen Quellcode
Ausgabepfad: Der Ordner, in dem der konvertierte Code gespeichert werden soll

Informationen zum Projekt¶

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.

Kunden-E-Mail: Geben Sie eine gültige E-Mail Adresse ein
Kundenunternehmen: Geben Sie den Namen Ihres Unternehmens ein
Projektname: Geben Sie einen Namen für Ihr Projekt ein

Dieses Beispiel zeigt, wie Sie den Codeprozessor nur unter Verwendung der grundlegenden Anforderungen ausführen können:

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

Nachdem Sie die Befehlsfolge eingegeben und die Eingabetaste gedrückt haben, zeigt das Tool Ihre aktuellen Einstellungen an und bittet Sie um eine Bestätigung, bevor es den Vorgang startet.

Aktuelle Konfiguration vor dem Start des Prozesses.

Möchten Sie Argumente hinzufügen oder ändern? Tippen Sie „n“ zum Abbrechen oder „y“ zum Fortfahren.

Überspringen der Projektbestätigung¶

Um die oben angezeigte Bestätigungsaufforderung zu umgehen, fügen Sie entweder –yes oder -y als Argument hinzu. Dies ist besonders wichtig, wenn Sie das Tool programmatisch verwenden, da die Bestätigungsaufforderung ohne diese Parameter jedes Mal angezeigt wird.

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

Durchführen einer Bewertung¶

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>

Jeder dieser Befehle kann zusätzliche Parameter akzeptieren. Weitere Einzelheiten finden Sie im Abschnitt „Konvertieren“.

Überprüfen der Toolversion¶

Um die Toolversion und die Codeverarbeitungsmaschine zu überprüfen, können Sie einen dieser Befehle verwenden:

sma --version
sma -v

Ermöglichung der Konvertierung von Databricks-Notebooks in Jupyter-Notebooks¶

Diese Option konvertiert Python (.python) und/oder Scala (.scala) Quelldateien in Jupyter-Notebook (.ipynb) Dateien. Die Konvertierung funktioniert unabhängig davon, ob die ursprünglichen Dateien aus Notebooks exportiert wurden oder normale Codedateien waren.

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

Einstellen der SQL-Konfiguration des Quellcodes¶

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

Benötigen Sie weitere Hilfe?¶

Um allgemeine Hilfeinformationen für die Befehlszeilenschnittstelle (CLI) anzuzeigen, können Sie einen der folgenden Befehle verwenden:

sma --help
sma -h

Um mehr über bestimmte Befehle zu erfahren, können Sie diesen Befehl ausführen:

sma <command> --help

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