Snowpark Migration Accelerator: SMA CLI の使用¶

説明¶

Snowpark Migration Accelerator（SMA）には、さまざまな操作を実行できるコマンドラインインターフェイス（CLI）が用意されています。この CLI を使用すると、コードプロセッサーを実行したり、アクセスコードを管理（インストールまたは表示）したり、 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.

インストール¶

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:

コマンド¶

ツールを実行するには、要件に基づいて一連のコマンドを設定する必要があります。long-command または short-command オプションは、以下の構文で使用できます。

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

以下のコマンドを使用できます。コマンドをクリックすると、その詳細な説明が表示されます。


ロングコマンド	ショートコマンド	説明
--help	-h	ヘルプドキュメントを表示します。
--version	-v	現在のツールバージョンを表示します。
install-access-code	install-ac	新しいアクセスコードをインストールします。
show-access-code	show-ac	インストールされているすべてのアクセスコードを表示します。
--input	-i	入力フォルダーの場所を指定します。
--output	-o	出力フォルダーの場所を指定します。
--assessment	-a	評価モードでツールを実行します。
--mapDirectory	-m	カスタムマッピングファイルを含むフォルダーを指定します。
--enableJupyter	-j	DatabricksノートブックのJupyter形式への変換を有効または無効にします。
--sql	-f	SQLコマンドに使用するデータベースエンジン構文を指定します。
--customerEmail	-e	お客様のメールアドレスを設定します。
--customerCompany	-c	お客様の会社名を設定します。
--projectName	-p	プロジェクト名を設定します。
--yes	-y	実行中に確認プロンプトをスキップします。

アクセスコードのインストール¶

コード変換プロセスを開始するには、まずアクセスコードをインストールする必要があります。これには2つの方法があります。

アクセスコードを直接入力します
アクセスコードを含むファイルへのパスを提供します（この方法は、オフラインで作業している場合や、制限の多いファイアウォールの内側で作業している場合に便利です）

以下のコマンドを実行すると、アクセスコードをインストールできます。

sma install-access-code <access-code>

このコマンドは前のコマンドと同じ結果になります。

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>

ライセンスのインストール中にエラーが発生した場合は、エラーメッセージが表示されます。

アクセスコードのリクエストについては、sma-support@snowflake.com にお問い合わせください

インストールされているアクセスコードの確認¶

現在コンピューターにインストールされているアクセスコードを確認するには、このコマンドを使用します。

sma show-access-code

このコマンドは、コンピューターに現在インストールされているすべてのアクセスコードの詳細を表示します。

変換¶

有効なライセンスをインストールした後、コードプロセッサーを実行してコードを変換できます。変換処理を開始するには、以下の引数を指定する必要があります。

入力パス: 元のソースコードが格納されているフォルダー
出力パス: 変換したコードを保存するフォルダー

プロジェクト情報¶

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.

お客様のメール: 有効なメールアドレスを入力します
お客様の会社: お客様の会社名を入力します
プロジェクト名: お客様のプロジェクト名を入力します

この例では、必須要件のみを使用してコードプロセッサーを実行する方法を示します。

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

一連のコマンドを入力して「Enter」キーを押すと、ツールに現在の設定が表示され、プロセスを開始する前に確認を求められます。

引数を追加または変更しますか。キャンセルする場合は「n」、続行する場合は「y」と入力します。

プロジェクト確認のスキップ¶

上記の確認プロンプトを回避するには、引数として --yes または -y のいずれかを追加します。これは、ツールをプログラムで使用する場合に特に重要です。これらのパラメーターがないと、毎回確認プロンプトが表示されるからです。

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

評価の実行¶

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>

これらのコマンドにはそれぞれパラメーターを追加することができます。詳細については、「変換」セクションをご参照ください。

ツールバージョンの確認¶

ツールバージョンとコード処理エンジンを確認するには、以下のコマンドのいずれかを使用できます。

sma --version
sma -v

DatabricksノートブックからJupyter Notebooksへの変換の有効化¶

このオプションはPython（.python）やScala（.scala）のソースファイルをJupyter Notebook（.ipynb）ファイルに変換します。変換は、元のファイルがノートブックからエクスポートされたものであるか、通常のコードファイルであるかに関係なく機能します。

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

ソースコードの SQL フレーバーの設定¶

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

お困りですか？¶

コマンドラインインターフェイス（CLI）の一般的なヘルプ情報を表示するには、以下のコマンドのいずれかを使用します。

sma --help
sma -h

特定のコマンドの詳細については、このコマンドを実行します。

sma <command> --help

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