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.
Die SMA verwendet einen einzigen Codeprozessor, der mit allen unterstützten Quellplattformen funktioniert. Für diesen Prozessor müssen Sie keine zusätzlichen Argumente angeben.
Installation¶
Bevor Sie die Befehlszeilenschnittstelle (CLI) installieren, müssen Sie sie herunterladen an einen Speicherort, auf den Sie zugreifen können. Wählen Sie die Installationsanleitung, die zu Ihrem Betriebssystem passt:
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.
| 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. |
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>
Um einen Zugangscode aus einer Datei zu installieren, verwenden Sie entweder die Option --file oder -f mit Ihrem Befehl, etwa so:
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¶
Wenn Sie den Codeprozessor zum ersten Mal ausführen, müssen Sie bestimmte Argumente angeben. Diese Argumente werden gespeichert und für zukünftige Ausführungen verwendet. Die erforderlichen Argumente sind dieselben, die auch beim Erstellen eines neuen Projekts in der Anwendung benötigt werden.
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.
.png „Bild“)
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.
Weitere Informationen über alle verfügbaren Parameter finden Sie unter diesem Link.
Durchführen einer Bewertung¶
Wenn Sie eine Bewertung durchführen, fügen Sie die Option --assessment oder -a zu den Standardkonvertierungsbefehlen hinzu. Hier sind Beispiele dafür, wie die Befehle aussehen sollten:
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.
Um Jupyter-Notebook zu konvertieren, fügen Sie entweder das '--enableJupyter' Flag oder dessen Kurzversion '-j' zu Ihrem Befehl hinzu.
sma -i <input-path> -o <output-path> --enableJupyter
Einstellen der SQL-Konfiguration des Quellcodes¶
Sie können angeben, welche SQL-Syntax verwendet werden soll, wenn ein SQL-Befehl erkannt wird. Verwenden Sie entweder den Befehl '--sql' oder dessen Abkürzung '-f'. Die unterstützten Syntaxoptionen sind ‚SparkSql‘ (dies ist die Standardeinstellung) und ‚HiveSql‘.
sma --input <input-path> --output <output-path> --sql SparkSql
sma --input <input-path> --output <output-path> --sql HiveSql
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
.png „Bild“)
Um mehr über bestimmte Befehle zu erfahren, können Sie diesen Befehl ausführen:
sma <command> --help
Um mehr über die Installation eines Zugangscodes zu erfahren, führen Sie den Befehl sma install-access-code --help aus.