前提条件インタラクティブ動画 CLI シナリオの取得 CLI シナリオの編集スクリプトモードリファレンス資料

AWS SCT CLI リファレンス

このセクションでは、 AWS SCT コマンドラインインターフェイス (CLI) を使い始める方法について説明します。また、このセクションでは、主要なコマンドと使用モードについても説明します。 AWS SCT CLI コマンドの詳細なリファレンスについては、を参照してくださいリファレンス資料。

トピック

AWS SCT コマンドラインインターフェイスを使用するための前提条件
AWS SCT CLI インタラクティブモード
AWS SCT CLI シナリオの取得
AWS SCT CLI シナリオの編集
AWS SCT CLI スクリプトモード
AWS SCT CLI リファレンス資料

AWS SCT コマンドラインインターフェイスを使用するための前提条件

Amazon Corretto 11 の最新バージョンをダウンロードしてインストールします。ダウンロードリンクなどの詳細については、『Amazon Corretto 11 ユーザーガイド』の「Amazon Corretto 11 のダウンロード」を参照してください。

の最新バージョンをダウンロードしてインストールします。 AWS SCT詳細については、「のインストール AWS SCT」を参照してください。

AWS SCT CLI インタラクティブモード

AWS SCT コマンドラインインターフェイスはインタラクティブモードで使用できます。このモードでは、コンソールにコマンドを 1 つずつ入力します。このインタラクティブモードを使用して、CLI コマンドの詳細を確認したり、最も一般的に使用される CLI シナリオをダウンロードしたりできます。

ソースデータベーススキーマをに変換するには AWS SCT、新しいプロジェクトの作成、ソースデータベースとターゲットデータベースへの接続、マッピングルールの作成、データベースオブジェクトの変換という一連の操作を実行します。このワークフローは複雑になる可能性があるため、 AWS SCT CLI モードではスクリプトを使用することをお勧めします。詳細については、「スクリプトモード」を参照してください。

AWS SCT CLI コマンドは、app AWS SCT インストールパスのフォルダから実行できます。Windows では、デフォルトのインストールパスは C:\Program Files\AWS Schema Conversion Tool\ です。このフォルダに AWSSchemaConversionToolBatch.jar ファイルが含まれていることを確認してください。

AWS SCT CLI インタラクティブモードに入るには、前提条件を満たした後で次のコマンドを使用します。


java -jar AWSSchemaConversionToolBatch.jar -type interactive

これで AWS SCT CLI コマンドを実行できます。/ コマンドは必ず新しい行で終了してください。また、コマンドパラメータの値の前後には必ず一重引用符 (') を使用してください。

注記

前述のコマンドが Unexpected error を返す場合は、次のステップを実行します。


java -Djdk.jar.maxSignatureFileSize=20000000 -jar AWSSchemaConversionToolBatch.jar

AWS SCT CLI インタラクティブモードで使用できるコマンドのリストを表示するには、次のコマンドを実行します。


help
/

AWS SCT CLI コマンドに関する情報を表示するには、次のコマンドを使用します。


help -command: 'command_name'
/

前述の例では、command_name をコマンドの名前に置き換えます。

AWS SCT CLI コマンドのパラメータに関する情報を表示するには、次のコマンドを使用します。


help -command: 'command_name' -parameters: 'parameters_list'
/

前述の例では、command_name をコマンドの名前に置き換えます。次に、parameters_list をコンマで区切ったパラメーター名のリストに置き換えます。

AWS SCT CLI インタラクティブモードでファイルからスクリプトを実行するには、次のコマンドを使用します。


ExecuteFile -file: 'file_path'
/

前述の例では、file_path をスクリプトを含むファイルへのパスに置き換えます。ファイルに .scts 拡張子が付いていることを確認してください。

AWS SCT CLI インタラクティブモードを終了するには、quitコマンドを実行します。

例

Convert コマンドの出力には、次の情報が表示されます。


help -command: 'Convert'
/

次の例は、Convert コマンドの 2 つのパラメータに関する情報を表示します。


help -command: 'Convert' -parameters: 'filter, treePath'
/

AWS SCT CLI シナリオの取得

AWS SCT 最も一般的に使用されるシナリオを取得するには、GetCliScenarioコマンドを使用できます。このコマンドをインタラクティブモードで実行し、ダウンロードしたテンプレートを編集できます。編集したファイルはスクリプトモードで使用します。

GetCliScenario コマンドは、選択したテンプレートまたは使用可能なすべてのテンプレートを指定したディレクトリに保存します。テンプレートには、スクリプトを実行するためのコマンドがすべて含まれています。これらのテンプレート内のファイルパス、データベース認証情報、オブジェクト名、およびその他のデータを必ず編集してください。また、使用しないコマンドは必ず削除し、必要に応じて新しいコマンドをスクリプトに追加してください。

GetCliScenarioコマンドを実行するには、前提条件を満たし、 AWS SCT CLI インタラクティブモードに入ります。詳細については、「インタラクティブ動画」を参照してください。

次に、次の構文を使用して GetCliScenario コマンドを実行し、 AWS SCT シナリオを取得します。


GetCliScenario -type: 'template_type' -directory: 'file_path'
/

前述の例では、template_type を次の表のテンプレートタイプのいずれかに置き換えます。次に、file_path をスクリプトをダウンロードするフォルダーのパスに置き換えます。管理者権限を要求しなくてもこのフォルダにアクセスできることを確認してください。 AWS SCT また、コマンドパラメータの値の前後には必ず一重引用符 (') を使用してください。

すべての AWS SCT CLI テンプレートをダウンロードするには、-type上記のコマンドをオプションなしで実行します。

次の表には、ダウンロードできる AWS SCT CLI テンプレートのタイプが含まれています。この表には、各テンプレートのファイル名と、スクリプトを使用して実行できる操作の説明が記載されています。

テンプレートのタイプ	ファイル名	説明
BTEQ ScriptConversion	`BTEQScriptConversionTemplate.scts`	テラデータの基本的なメタデータクエリ (BTEQ)、 FastExport FastLoad、 MultiLoad およびスクリプトを Amazon Redshift RSQL に変換します。詳細については、「ETL プロセスの変換」を参照してください。
ConversionApply	`ConversionTemplate.scts`	ソースデータベースのスキーマを変換し、変換されたコードをターゲットデータベースに適用します。オプションで、変換したコードを SQL スクリプトとして保存し、評価レポートを保存します。詳細については、「データベーススキーマの変換」を参照してください。
GenericAppConversion	`GenericApplicationConversionTemplate.scts`	汎用アプリケーションコンバーターを使用して、アプリケーションに埋め込まれた SQL コードを変換します。 AWS SCT 詳細については、「アプリケーション内の SQL コードの変換」を参照してください。
HadoopMigration	`HadoopMigrationTemplate.scts`	オンプレミスの Hadoop クラスターを Amazon EMR に移行します。詳細については、「Apache Hadoop を AWS SCT のソースとして使用」を参照してください。
HadoopResumeMigration	`HadoopResumeMigrationTemplate.scts`	中断されたオンプレミス Hadoop クラスターの Amazon EMR への移行を再開します。詳細については、「Apache Hadoop を AWS SCT のソースとして使用」を参照してください。
Informatica	`InformaticaConversionTemplate.scts`	Informatica の抽出、変換、ロード (ETL) スクリプトに埋め込まれている SQL コードを変換します。ETL スクリプトでソースデータベースとターゲットデータベースへの接続を設定し、変換後のスクリプトを保存します。詳細については、「Informatica ETL スクリプトの変換」を参照してください。
LanguageSpecificAppConversion	`LanguageSpecificAppConversionTemplate.scts`	C#、C++、Java、および Pro*C アプリケーションに埋め込まれた SQL コードをアプリケーションコンバータで変換します。 AWS SCT 詳細については、「アプリケーション SQL の変換」を参照してください。
OozieConversion	`OozieConversionTemplate.scts`	Apache Oozie ワークフローをに変換します。 AWS Step Functions詳細については、「Apache Oozie を AWS SCT のソースとしての使用」を参照してください。
RedshiftAgent	`DWHDataMigrationTemplate.scts`	ソースデータウェアハウスのスキーマを変換し、変換されたコードをターゲットの Amazon Redshift データベースに適用します。次に、データ抽出エージェントを登録し、データ移行タスクを作成して開始します。詳細については、「データウェアハウスから Amazon Redshift への移行」を参照してください。
ReportCreation	`ReportCreationTemplate.scts`	複数のソースデータベーススキーマのデータベース移行レポートを作成します。次に、このレポートを CSV または PDF ファイルとして保存します。詳細については、「移行評価レポート」を参照してください。
SQL ScriptConversion	`SQLScriptConversionTemplate.scts`	SQL*Plus または TSQL スクリプトを PL/SQL に変換し、変換されたスクリプトを保存します。また、評価レポートも保存します。

AWS SCT CLI テンプレートをダウンロードしたら、テキストエディタを使用して、ソースデータベースとターゲットデータベースで実行するようにスクリプトを設定します。次に、 AWS SCT CLI スクリプトモードを使用してスクリプトを実行します。詳細については、「AWS SCT CLI スクリプトモード」を参照してください。

例

次の例では、すべてのテンプレートを C:\SCT\Templates フォルダにダウンロードします。


GetCliScenario -directory: 'C:\SCT\Templates'
/

次の例では、ConversionApply 操作用のテンプレートを C:\SCT\Templates フォルダにダウンロードします。


GetCliScenario -type: 'ConversionApply' -directory: 'C:\SCT\Templates'
/

AWS SCT CLI シナリオの編集

シナリオテンプレートをダウンロードしたら、データベースで実行できる作業スクリプトになるように設定します。

どのテンプレートでも、ソースデータベースとターゲットデータベースのドライバーへのパスを必ず指定してください。詳細については、「必要なデータベースドライバーのダウンロード」を参照してください。

ソースデータベースとターゲットデータベースのデータベース認証情報を必ず含めてください。また、変換プロジェクトのソースとターゲットのペアを記述するマッピングルールを必ず設定してください。詳細については、「マッピングルールの作成」を参照してください。

次に、実行する操作の範囲を設定します。使用しないコマンドを削除したり、新しいコマンドをスクリプトに追加したりできます。

たとえば、ソース Oracle データベースのすべてのスキーマを PostgreSQL に変換することを計画しているとします。次に、データベース移行評価レポートを PDF として保存し、変換したコードをターゲットデータベースに適用する予定です。この場合は、ConversionApply 操作用のテンプレートを使用できます。 AWS SCT CLI テンプレートを編集するには、次の手順に従います。

`ConversionApply`操作用の AWS SCT CLI テンプレートを編集するには

ダウンロードした ConversionTemplate.scts を開きます。詳細については、「例」を参照してください。
-filter CreateFilter、-filter、SaveTargetSQL、ApplyToTarget SaveTargetSQ、SaveReportCSV の各オペレーションをスクリプトから削除LbyStatement、変換します。
オペレーション内の oracle_driver_file にはSetGlobalSettings、Oracle ドライバーへのパスを入力します。次に、[postgresql_driver_file] には、PostgreSQL ドライバーへのパスを入力します。

他のデータベースエンジンを使用する場合は、設定に適切な名前を使用してください。SetGlobalSettingsオペレーションで設定できるグローバル設定の一覧については、の「グローバル設定マトリックス」を参照してください。 リファレンス資料
(オプション) にはCreateProject、プロジェクトの名前とローカルプロジェクトファイルの場所を入力します。デフォルト値のまま続行する場合は、管理者権限を要求しなくても、 AWS SCT が C:\temp フォルダ内にファイルを作成できることを確認してください。
にはAddSource、ソースデータベースサーバーの IP アドレスを入力します。また、ソースデータベースサーバーに接続するためのユーザー名、パスワード、およびポートを入力します。
にはAddTarget、ターゲットデータベースサーバの IP アドレスを入力します。また、ソースデータベースサーバーに接続するためのユーザー名、パスワード、およびポートを入力します。
(オプション) にはAddServerMapping、マッピングルールに追加するソースデータベースオブジェクトとターゲットデータベースオブジェクトを入力します。sourceTreePath と targetTreePath パラメータを使用してデータベースオブジェクトへのパスを指定できます。オプションで、sourceNamePath および targetNamePath を使用してデータベースオブジェクトの名前を指定できます。詳細については、『リファレンス資料』の [サーバーマッピングコマンド] を参照してください。

AddServerMappingこのオペレーションのデフォルト値は、すべてのソーススキーマをターゲットデータベースにマップします。
ファイルを保存し、スクリプトモードを使用して実行します。詳細については、「スクリプトモード」を参照してください。

AWS SCT CLI スクリプトモード

AWS SCT CLI スクリプトを作成するか、テンプレートを編集したら、RunSCTBatchコマンドで実行できます。必ず CLI .scts スクリプトに拡張子を付けてファイルを保存してください。

AWS SCT CLI スクリプトは、app AWS SCT インストールパスのフォルダから実行できます。Windows では、デフォルトのインストールパスは C:\Program Files\AWS Schema Conversion Tool\ です。このフォルダに RunSCTBatch.cmd または RunSCTBatch.sh ファイルが含まれていることを確認してください。また、このフォルダには AWSSchemaConversionToolBatch.jar ファイルが含まれている必要があります。

または、オペレーティングシステムの PATH 環境変数に RunSCTBatch ファイルへのパスを追加することもできます。PATH環境変数を更新すると、任意のフォルダから AWS SCT CLI スクリプトを実行できます。

AWS SCT CLI スクリプトを実行するには、Windows で次のコマンドを使用します。


RunSCTBatch.cmd --pathtoscts "file_path"

前述の例では、file_path をスクリプトを含むファイルへのパスに置き換えます。

AWS SCT CLI スクリプトを実行するには、Linux で次のコマンドを使用します。


RunSCTBatch.sh --pathtoscts "file_path"

前述の例では、file_path をスクリプトを含むファイルへのパスに置き換えます。

このコマンドには、データベースの認証情報、コンソール出力の詳細レベルなどのオプションパラメータを指定できます。詳細については、「」 AWS SCT リファレンス資料にあるコマンドラインインターフェイスリファレンスをダウンロードしてください。

例

次の例では、C:\SCT\Templates フォルダで ConversionTemplate.scts を実行します。この例は Windows で使用できます。


RunSCTBatch.cmd --pathtoscts "C:\SCT\Templates\ConversionTemplate.scts"

次の例では /home/user/SCT/Templates ディレクトリの ConversionTemplate.scts スクリプトを実行します。この例は Linux で使用できます。


RunSCTBatch.sh --pathtoscts "/home/user/SCT/Templates/ConversionTemplate.scts"