翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# の CLI リファレンス AWS Schema Conversion Tool
このセクションでは、 AWS SCT コマンドラインインターフェイス (CLI) の使用を開始する方法について説明します。また、このセクションでは、主要なコマンドと使用モードについても説明します。CLI コマンドの完全なリファレンスについては、 AWS SCT 「」を参照してください[リファレンス資料](#CHAP_Reference.Download)。
**Topics**
+ [AWS SCT コマンドラインインターフェイスを使用するための前提条件](#CHAP_Reference.Prerequisites)
+ [AWS SCT CLI インタラクティブモード](#CHAP_Reference.InteractiveMode)
+ [CLI AWS SCT シナリオの取得](#CHAP_Reference.Scenario)
+ [CLI AWS SCT シナリオの編集](#CHAP_Reference.Editing)
+ [AWS SCT CLI スクリプトモード](#CHAP_Reference.ScriptMode)
+ [AWS SCT CLI リファレンスマテリアル](#CHAP_Reference.Download)
## AWS SCT コマンドラインインターフェイスを使用するための前提条件
Amazon Corretto 11 の最新バージョンをダウンロードしてインストールします。ダウンロードリンクなどの詳細については、『*Amazon Corretto 11 ユーザーガイド*』の「[Amazon Corretto 11 のダウンロード](https://docs.aws.amazon.com/corretto/latest/corretto-11-ug/downloads-list.html)」を参照してください。
の最新バージョンをダウンロードしてインストールします AWS SCT。詳細については、「[のインストール AWS Schema Conversion Tool](CHAP_Installing.Procedure.md)」を参照してください。
## AWS SCT CLI インタラクティブモード
AWS SCT コマンドラインインターフェイスはインタラクティブモードで使用できます。このモードでは、コンソールにコマンドを 1 つずつ入力します。このインタラクティブモードを使用して、CLI コマンドの詳細を確認したり、最も一般的に使用される CLI シナリオをダウンロードしたりできます。
でソースデータベーススキーマを変換するには AWS SCT、シーケンスオペレーションを実行します。新しいプロジェクトの作成、ソースデータベースとターゲットデータベースへの接続、マッピングルールの作成、データベースオブジェクトの変換です。このワークフローは複雑になる可能性があるため、 CLI AWS SCT モードでスクリプトを使用することをお勧めします。詳細については、「[スクリプトモード](#CHAP_Reference.ScriptMode)」を参照してください。
AWS SCT CLI コマンドは、 AWS SCT インストールパスの `app`フォルダから実行できます。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\$1name* をコマンドの名前に置き換えます。
AWS SCT CLI コマンドのパラメータに関する情報を表示するには、次のコマンドを使用します。
```
help -command: 'command_name' -parameters: 'parameters_list'
/
```
前述の例では、*command\$1name* をコマンドの名前に置き換えます。次に、*parameters\$1list* をコンマで区切ったパラメーター名のリストに置き換えます。
AWS SCT CLI インタラクティブモードでファイルからスクリプトを実行するには、次のコマンドを使用します。
```
ExecuteFile -file: 'file_path'
/
```
前述の例では、*file\$1path* をスクリプトを含むファイルへのパスに置き換えます。ファイルに `.scts` 拡張子が付いていることを確認してください。
CLI AWS SCT インタラクティブモードを終了するには、 `quit` コマンドを実行します。
### 例
`Convert` コマンドの出力には、次の情報が表示されます。
```
help -command: 'Convert'
/
```
次の例は、`Convert` コマンドの 2 つのパラメータに関する情報を表示します。
```
help -command: 'Convert' -parameters: 'filter, treePath'
/
```
## CLI AWS SCT シナリオの取得
最も一般的に使用される AWS SCT シナリオを取得するには、 `GetCliScenario` コマンドを使用できます。このコマンドをインタラクティブモードで実行し、ダウンロードしたテンプレートを編集できます。編集したファイルはスクリプトモードで使用します。
`GetCliScenario` コマンドは、選択したテンプレートまたは使用可能なすべてのテンプレートを指定したディレクトリに保存します。テンプレートには、スクリプトを実行するためのコマンドがすべて含まれています。これらのテンプレート内のファイルパス、データベース認証情報、オブジェクト名、およびその他のデータを必ず編集してください。また、使用しないコマンドは必ず削除し、必要に応じて新しいコマンドをスクリプトに追加してください。
`GetCliScenario`コマンドを実行するには、前提条件を満たし、 AWS SCT CLI インタラクティブモードに入ります。詳細については、「[インタラクティブ動画](#CHAP_Reference.InteractiveMode)」を参照してください。
次に、次の構文を使用して `GetCliScenario` コマンドを実行し、 AWS SCT シナリオを取得します。
```
GetCliScenario -type: 'template_type' -directory: 'file_path'
/
```
前述の例では、*template\$1type* を次の表のテンプレートタイプのいずれかに置き換えます。次に、*file\$1path* をスクリプトをダウンロードするフォルダーのパスに置き換えます。 AWS SCT が管理者権限をリクエストせずにこのフォルダにアクセスできることを確認してください。また、コマンドパラメータの値の前後には必ず一重引用符 (`'`) を使用してください。
すべての AWS SCT CLI テンプレートをダウンロードするには、 `-type`オプションを指定せずに前述のコマンドを実行します。
次の表に、ダウンロードできる AWS SCT CLI テンプレートのタイプを示します。この表には、各テンプレートのファイル名と、スクリプトを使用して実行できる操作の説明が記載されています。
| テンプレートのタイプ | ファイル名 | 説明 |
| --- | --- | --- |
| BTEQScriptConversion | `BTEQScriptConversionTemplate.scts` | Teradata Basic Teradata Query (BTEQ)、FastExport、FastLoad、MultiLoad スクリプトを Amazon Redshift RSQL に変換します。詳細については、「[ETL を使用したデータの変換](CHAP-converting-etl.md)」を参照してください。 |
| 変換/適用 | `ConversionTemplate.scts` | ソースデータベースのスキーマを変換し、変換されたコードをターゲットデータベースに適用します。オプションで、変換したコードを SQL スクリプトとして保存し、評価レポートを保存します。詳細については、「[スキーマの変換](CHAP_Converting.md)」を参照してください。 |
| GenericAppConversion | `GenericApplicationConversionTemplate.scts` | 汎用アプリケーションコンバーターを使用して AWS SCT 、アプリケーションに埋め込まれた SQL コードを変換します。詳細については、「[SQL コード](CHAP_Converting.App.Generic.md)」を参照してください。 |
| HadoopMigration | `HadoopMigrationTemplate.scts` | オンプレミスの Hadoop クラスターを Amazon EMR に移行します。詳細については、「[を使用した Apache Hadoop データベースへの接続 AWS Schema Conversion Tool](CHAP_Source.Hadoop.md)」を参照してください。 |
| HadoopResumeMigration | `HadoopResumeMigrationTemplate.scts` | 中断されたオンプレミス Hadoop クラスターの Amazon EMR への移行を再開します。詳細については、「[を使用した Apache Hadoop データベースへの接続 AWS Schema Conversion Tool](CHAP_Source.Hadoop.md)」を参照してください。 |
| Informatica | `InformaticaConversionTemplate.scts` | Informatica の抽出、変換、ロード (ETL) スクリプトに埋め込まれている SQL コードを変換します。ETL スクリプトでソースデータベースとターゲットデータベースへの接続を設定し、変換後のスクリプトを保存します。詳細については、「[Informatica ETL スクリプト](CHAP-converting-informatica.md)」を参照してください。 |
| 言語特有のアプリ変換 | `LanguageSpecificAppConversionTemplate.scts` | C\$1、C\$1\$1、Java、および Pro\$1C アプリケーションに埋め込まれた SQL コードをアプリケーションコンバータで変換します。 AWS SCT 詳細については、「[アプリケーション SQL の変換](CHAP_Converting.App.md)」を参照してください。 |
| OOZIE 変換 | `OozieConversionTemplate.scts` | Apache Oozie ワークフローを に変換します AWS Step Functions。詳細については、「[を使用した Apache Oozie ワークフローへの接続 AWS Schema Conversion Tool](CHAP_Source.Oozie.md)」を参照してください。 |
| 赤方偏移エージェント | `DWHDataMigrationTemplate.scts` | ソースデータウェアハウスのスキーマを変換し、変換されたコードをターゲットの Amazon Redshift データベースに適用します。次に、データ抽出エージェントを登録し、データ移行タスクを作成して開始します。詳細については、「[データウェアハウスからの移行](agents.md)」を参照してください。 |
| ReportCreation | `ReportCreationTemplate.scts` | 複数のソースデータベーススキーマのデータベース移行レポートを作成します。次に、このレポートを CSV または PDF ファイルとして保存します。詳細については、「[評価レポート](CHAP_AssessmentReport.md)」を参照してください。 |
| SQL スクリプト変換 | `SQLScriptConversionTemplate.scts` | SQL\$1Plus または TSQL スクリプトを PL/SQL に変換し、変換されたスクリプトを保存します。また、評価レポートも保存します。 |
AWS SCT CLI テンプレートをダウンロードしたら、テキストエディタを使用して、ソースデータベースとターゲットデータベースで実行するスクリプトを設定します。次に、CLI AWS SCT スクリプトモードを使用してスクリプトを実行します。詳細については、「[AWS SCT CLI スクリプトモード](#CHAP_Reference.ScriptMode)」を参照してください。
### 例
次の例では、すべてのテンプレートを `C:\SCT\Templates` フォルダにダウンロードします。
```
GetCliScenario -directory: 'C:\SCT\Templates'
/
```
次の例では、`ConversionApply` 操作用のテンプレートを `C:\SCT\Templates` フォルダにダウンロードします。
```
GetCliScenario -type: 'ConversionApply' -directory: 'C:\SCT\Templates'
/
```
## CLI AWS SCT シナリオの編集
シナリオテンプレートをダウンロードしたら、データベースで実行できる作業スクリプトになるように設定します。
どのテンプレートでも、ソースデータベースとターゲットデータベースのドライバーへのパスを必ず指定してください。詳細については、「[用の JDBC ドライバーのインストール AWS Schema Conversion Tool](CHAP_Installing.JDBCDrivers.md)」を参照してください。
ソースデータベースとターゲットデータベースのデータベース認証情報を必ず含めてください。また、変換プロジェクトのソースとターゲットのペアを記述するマッピングルールを必ず設定してください。詳細については、「[データ型のマッピング](CHAP_Mapping.md)」を参照してください。
次に、実行する操作の範囲を設定します。使用しないコマンドを削除したり、新しいコマンドをスクリプトに追加したりできます。
たとえば、ソース Oracle データベースのすべてのスキーマを PostgreSQL に変換することを計画しているとします。次に、データベース移行評価レポートを PDF として保存し、変換したコードをターゲットデータベースに適用する予定です。この場合は、`ConversionApply` 操作用のテンプレートを使用できます。 AWS SCT CLI テンプレートを編集するには、次の手順に従います。
**`ConversionApply` オペレーションの AWS SCT CLI テンプレートを編集するには**
1. ダウンロードした `ConversionTemplate.scts` を開きます。詳細については、「[例](#CHAP_Reference.Scenario.Examples)」を参照してください。
1. スクリプトから [**CreateFilter**]、[**Convert -filter**]、[**ApplyToTarget -filter**]、[**SaveTargetSQL**]、[**SaveTargetSQLbyStatement**]、[**SaveReportCSV**] の各操作を削除します。
1. [**SetGlobalSettings**] 操作の [**oracle\$1driver\$1file**] には、Oracle ドライバーへのパスを入力します。次に、[**postgresql\$1driver\$1file**] には、PostgreSQL ドライバーへのパスを入力します。
他のデータベースエンジンを使用する場合は、設定に適切な名前を使用してください。[**SetGlobalSettings**] 操作で設定できるグローバル設定の一覧については、『[リファレンス資料](#CHAP_Reference.Download)』の「**グローバル設定マトリックス**」を参照してください。
1. (オプション) [**CreateProject**] には、プロジェクトの名前とローカルプロジェクトファイルの場所を入力します。デフォルト値のまま続行する場合は、管理者権限を要求しなくても、 AWS SCT が `C:\temp` フォルダ内にファイルを作成できることを確認してください。
1. [**AddSource**] には、ソースデータベースサーバーの IP アドレスを入力します。また、ソースデータベースサーバーに接続するためのユーザー名、パスワード、およびポートを入力します。
1. [**AddTarget**] には、ターゲットデータベースサーバーの IP アドレスを入力します。また、ソースデータベースサーバーに接続するためのユーザー名、パスワード、およびポートを入力します。
1. (オプション) [**AddServerMapping**] には、マッピングルールに追加するソースデータベースオブジェクトとターゲットデータベースオブジェクトを入力します。`sourceTreePath` と `targetTreePath` パラメータを使用してデータベースオブジェクトへのパスを指定できます。オプションで、`sourceNamePath` および `targetNamePath` を使用してデータベースオブジェクトの名前を指定できます。詳細については、『[リファレンス資料](#CHAP_Reference.Download)』の [**サーバーマッピングコマンド**] を参照してください。
[**AddServerMapping**] 操作のデフォルト値は、すべてのソーススキーマをターゲットデータベースにマップします。
1. ファイルを保存し、スクリプトモードを使用して実行します。詳細については、「[スクリプトモード](#CHAP_Reference.ScriptMode)」を参照してください。
## AWS SCT CLI スクリプトモード
AWS SCT CLI スクリプトを作成またはテンプレートを編集したら、 `RunSCTBatch` コマンドを使用して実行できます。必ず CLI `.scts` スクリプトに拡張子を付けてファイルを保存してください。
CLI AWS SCT スクリプトは、 AWS SCT インストールパスの `app`フォルダから実行できます。Windows では、デフォルトのインストールパスは `C:\Program Files\AWS Schema Conversion Tool\` です。このフォルダに `RunSCTBatch.cmd` または `RunSCTBatch.sh` ファイルが含まれていることを確認してください。また、このフォルダには `AWSSchemaConversionToolBatch.jar` ファイルが含まれている必要があります。
または、オペレーティングシステムの `PATH` 環境変数に `RunSCTBatch` ファイルへのパスを追加することもできます。`PATH` 環境変数を更新したら、任意のフォルダから AWS SCT CLI スクリプトを実行できます。
CLI スクリプトを実行するには、Windows AWS SCT で次のコマンドを使用します。
```
RunSCTBatch.cmd --pathtoscts "file_path"
```
前述の例では、*file\$1path* をスクリプトを含むファイルへのパスに置き換えます。
CLI スクリプトを実行するには、Linux AWS SCT で次のコマンドを使用します。
```
RunSCTBatch.sh --pathtoscts "file_path"
```
前述の例では、*file\$1path* をスクリプトを含むファイルへのパスに置き換えます。
このコマンドには、データベースの認証情報、コンソール出力の詳細レベルなどのオプションパラメータを指定できます。詳細については、「」の AWS SCT コマンドラインインターフェイスリファレンスをダウンロードしてください[リファレンス資料](#CHAP_Reference.Download)。
### 例
次の例では、`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"
```
## AWS SCT CLI リファレンスマテリアル
AWS Schema Conversion Tool コマンドラインインターフェイス (CLI) に関する参考資料は、次のガイドの[AWS Schema Conversion Tool 「CLI リファレンス](https://s3.amazonaws.com/publicsctdownload/AWS+SCT+CLI+Reference.pdf)」を参照してください。