SSMA コンソールの実行 (MySQLToSQL)

2025-06-05

Microsoft では、SSMA アクティビティを実行および制御するための堅牢なスクリプトファイルコマンドのセットを提供しています。

コンソールアプリケーションでは、このセクションで列挙されているように、特定の標準スクリプトファイルコマンドを使用します。

プロジェクトスクリプトファイルのコマンド

命令

新規プロジェクトを作成
新しい SSMA プロジェクトを作成します。

プロジェクトコマンドは、プロジェクトの作成、プロジェクトのオープン、保存、および終了を処理します。

スクリプト

project-folder: 作成されるプロジェクトのフォルダーを示します。
project-name: プロジェクトの名前を示します。 {string}
overwrite-if-exists: 省略可能な属性。既存のプロジェクトを上書きするかどうかを示します。 {boolean}
project-type: 省略可能な属性。プロジェクトの種類 ("sql-server-2005" プロジェクト、"sql-server-2008" プロジェクト、"sql-server-2012" または "sql-server-2014" プロジェクト、または "sql-azure" プロジェクト) を示します。既定値は "sql-server-2008" です。

構文の例:

<create-new-project  
  
   project-folder="<project-folder>"  
  
   project-name="<project-name>"  
  
   overwrite-if-exists="<true/false>"   (optional)  
  
   project-type=="<sql-server-2008 | sql-server-2005 | sql-server-2012 | sql-server-2014 | sql-azure>"   (optional)  
  
/>

属性 'overwrite-if-exists' は既定で false です 。

属性 'project-type' は既定で sql-server-2008 です。

命令

open-project:
既存のプロジェクトを開きます。

スクリプト

project-folder は、作成されるプロジェクトのフォルダーを示します。指定したフォルダーが存在しない場合、コマンドは失敗します。 {string}
project-name はプロジェクトの名前を示します。指定したプロジェクトが存在しない場合、コマンドは失敗します。 {string}

構文の例:

<open-project  
  
   project-folder="<project-folder>"  
  
   project-name="<project-name>"  
  
/>

Von Bedeutung

SSMA For MySQL コンソールアプリケーションでは、下位互換性がサポートされています。以前のバージョンの SSMA によって作成されたプロジェクトを開くことができます。

命令

save-project: 移行プロジェクトを保存します。

スクリプト

構文の例:

<save-project/>

命令

プロジェクトを閉じる
: 移行プロジェクトを閉じます。

スクリプト

構文の例:

<save-project/>

命令

プロジェクトを閉じる
: 移行プロジェクトを閉じます。

スクリプト

構文の例:

<close-project  
  
   if-modified="<save/error/ignore>"   (optional)  
  
/>

属性 'if-modified' は省略可能です。既定では無視されます。

データベース接続スクリプトファイルのコマンド

データベース接続コマンドは、データベースへの接続に役立ちます。

UI の参照機能は、コンソールではサポートされていません。
WINDOWS 認証とポート パラメーターは、SQL Azure に接続するときに適用されません。
「スクリプトファイルの作成」の詳細については、「スクリプトファイルの作成 (MySQLToSQL)」を参照してください。

命令

接続元データベース

ソースデータベースへの接続を実行し、ソースデータベースの高度なメタデータを読み込みますが、すべてのメタデータを読み込むわけではありません。
ソースへの接続を確立できない場合は、エラーが生成され、コンソールアプリケーションはそれ以降の実行を停止します

スクリプト

サーバー定義は、サーバー接続ファイルまたはスクリプトファイルのサーバーセクションの接続ごとに定義された名前属性から取得されます。

構文の例:

<connect-source-database  server="<server-unique-name>"/>

命令

強制ロード元/対象データベース

ソースメタデータを読み込みます。
移行プロジェクトをオフラインで作業する場合に便利です。
ソース/ターゲットへの接続を確立できない場合は、エラーが生成され、コンソールアプリケーションはそれ以降の実行を停止します

スクリプト

コマンドラインパラメーターとして 1 つまたは複数のメタベースノードが必要です。

構文の例:

<force-load metabase="<source/target>"  
  
      <metabase-object object-name="<object-name>"/>  
  
</force-load>

命令

ソースデータベースを再接続する

ソースデータベースに再接続しますが、connect-source-database コマンドとは異なり、メタデータは読み込まれません。
ソースとの (再) 接続を確立できない場合は、エラーが生成され、コンソールアプリケーションはそれ以降の実行を停止します。

スクリプト

構文の例:

<reconnect-source-database  server="<server-unique-name>"/>

命令

ターゲットデータベースに接続する

ターゲット SQL Server または Azure SQL Database に接続し、メタデータ全体ではなく、ターゲットデータベースの高度なメタデータを読み込みます。
ターゲットへの接続を確立できない場合は、エラーが生成され、コンソールアプリケーションはそれ以降の実行を停止します。

スクリプト

サーバー定義は、サーバー接続ファイルまたはスクリプトファイルのサーバーセクションの接続ごとに定義された名前属性から取得されます

構文の例:

<connect-target-database  server="<server-unique-name>"/>

命令

ターゲットデータベースを再接続する

connect-target-database コマンドとは異なり、ターゲットデータベースに再接続しますが、メタデータは読み込まれません。
ターゲットへの (再) 接続を確立できない場合は、エラーが生成され、コンソールアプリケーションはそれ以降の実行を停止します。

スクリプト

構文の例:

<reconnect-target-database  server="<server-unique-name>"/>

レポートスクリプトファイルのコマンド

レポートコマンドは、さまざまな SSMA コンソールアクティビティのパフォーマンスに関するレポートを生成します。

命令

評価レポートを生成する

ソースデータベースの評価レポートを生成します。
このコマンドを実行する前にソースデータベース接続が実行されていない場合は、エラーが生成され、コンソールアプリケーションが終了します。
コマンドの実行中にソースデータベースサーバーに接続できないと、コンソールアプリケーションも終了します。

スクリプト

assessment-report-folder: 評価レポートが格納されるフォルダーを指定します。(省略可能な属性)
object-name: 評価レポートの生成で考慮されるオブジェクトを指定します (個々のオブジェクト名またはグループオブジェクト名を指定できます)。
object-type: は、object-name 属性で指定されたオブジェクト型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクト型は "category" になります)。
assessment-report-overwrite: 評価レポートフォルダーが既に存在する場合に上書きするかどうかを指定します。

既定値: false。 (省略可能な属性)
write-summary-report-to: 要約レポートを生成するパスを指定します。

フォルダーパスのみが指定されている場合は、 AssessmentReport<n>.XML という名前でファイルが作成されます。 (省略可能な属性)

レポートの作成には、さらに 2 つのサブカテゴリがあります。
- report-errors (="true/false", デフォルトは "false" の場合 (省略可能な属性))
- verbose (="true/false", デフォルトは "false" の場合 (省略可能な属性))

構文の例:

<generate-assessment-report  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"  
  
   write-summary-report-to="<file-name/folder-name>"   (optional)  
  
   verbose="<true/false>"   (optional)  
  
   report-errors="<true/false>"   (optional)  
  
   conversion-report-folder="<folder-name>"   (optional)  
  
   conversion-report-overwrite="<true/false>"   (optional)  
  
/>

又は

<generate-assessment-report  
  
   conversion-report-folder="<folder-name>"   (optional)  
  
   conversion-report-overwrite="<true/false>"   (optional)  
  
>  
  
      <metabase-object object-name="<object-name>"  
  
         object-type="<object-category>"/>  
  
</generate-assessment-report>

移行スクリプトファイルのコマンド

移行コマンドは、ターゲットデータベーススキーマをソーススキーマに変換し、データをターゲットサーバーに移行します。

移行コマンドの既定のコンソール出力設定は "Full" 出力レポートで、詳細なエラー報告はありません。ソースオブジェクトツリーのルートノードの概要のみ。

命令

コンバートスキーマ

ソースからターゲットスキーマへのスキーマ変換を実行します。
このコマンドを実行する前にソースまたはターゲットのデータベース接続が実行されていない場合、またはコマンドの実行中にソースまたはターゲットデータベースサーバーへの接続が失敗した場合は、エラーが生成され、コンソールアプリケーションが終了します。

スクリプト

conversion-report-folder: 評価レポートが格納されるフォルダーを指定します。(省略可能な属性)
object-name: スキーマの変換を検討するオブジェクトを指定します (個々のオブジェクト名またはグループオブジェクト名を指定できます)。
object-type: は、object-name 属性で指定されたオブジェクト型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクト型は "category" になります)。
conversion-report-overwrite: 評価レポートフォルダーが既に存在する場合に上書きするかどうかを指定します。

既定値: false。 (省略可能な属性)
write-summary-report-to: 要約レポートを生成するパスを指定します。

フォルダーパスのみが指定されている場合は、 SchemaConversionReport<n>.XML という名前でファイルが作成されます。 (省略可能な属性)

サマリーレポートの作成には、さらに 2 つのサブカテゴリがあります。
- report-errors (="true/false", デフォルトは "false" の場合 (省略可能な属性))
- verbose (="true/false", デフォルトは "false" の場合 (省略可能な属性))

構文の例:

<convert-schema  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"  
  
   write-summary-report-to="<file-name/folder-name>"   (optional)  
  
   verbose="<true/false>"   (optional)  
  
   report-errors="<true/false>"   (optional)  
  
   conversion-report-folder="<folder-name>"   (optional)  
  
   conversion-report-overwrite="<true/false>"   (optional)  
  
/>

又は

<convert-schema  
  
   conversion-report-folder="<folder-name>"   (optional)  
  
   conversion-report-overwrite="<true/false>"   (optional)  
  
      <metabase-object object-name="<object-names>"  
  
         object-type="<object-category>"/>  
  
</convert-schema>

命令

データを移行する

ソースからターゲットにデータを移行します。

スクリプト

object-name: データの移行を検討するソースオブジェクトを指定します (個々のオブジェクト名またはグループオブジェクト名を持つことができます)。
object-type: は、object-name 属性で指定されたオブジェクト型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクト型は "category" になります)。
write-summary-report-to: 要約レポートを生成するパスを指定します。

フォルダーパスのみが指定されている場合は、 DataMigrationReport<n>.XML という名前でファイルが作成されます。 (省略可能な属性)

レポートの作成には、さらに 2 つのサブカテゴリがあります。
- report-errors (="true/false", デフォルトは "false" の場合 (省略可能な属性))
- verbose (="true/false", デフォルトは "false" の場合 (省略可能な属性))

構文の例:

<migrate-data  
  
   write-summary-report-to="<file-name/folder-name>"  
  
   report-errors="true" verbose="true">  
  
      <metabase-object object-name="<object-name>"/>  
  
      <metabase-object object-name="<object-name>"/>  
  
      <metabase-object object-name="<object-name>"/>  
  
      <data-migration-connection  
  
         source-use-last-used="true"/source-server="<server-unique-name>"  
  
         target-use-last-used="true"/target-server="<server-unique-name>"/>  
  
</migrate-data>

又は

<migrate-data  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"  
  
   write-summary-report-to="<file-name/folder-name>"  
  
   report-errors="true" verbose="true"/>

移行準備スクリプトファイルコマンド

移行準備コマンドは、ソースデータベースとターゲットデータベース間のスキーママッピングを開始します。

命令

マップ・スキーマ

ソースデータベースからターゲットスキーマへのスキーママッピング。

スクリプト

source-schema は、移行するソーススキーマを指定します。
sql-server-schema は、移行するターゲットスキーマを指定します。

構文の例:

<map-schema  
  
   source-schema="<source-schema>"  
  
   sql-server-schema="<target-schema>"/>

管理容易性スクリプトファイルのコマンド

Manageability コマンドは、ターゲットデータベースオブジェクトをソースデータベースと同期するのに役立ちます。

注

命令

同期対象

ターゲットオブジェクトをターゲットデータベースと同期します。
ソースデータベースに対してこのコマンドを実行すると、エラーが発生します。
このコマンドを実行する前にターゲットデータベース接続が実行されなかった場合、またはコマンドの実行中にターゲットデータベースサーバーへの接続が失敗した場合は、エラーが生成され、コンソールアプリケーションが終了します。

スクリプト

object-name: ターゲットデータベースとの同期を検討するオブジェクトを指定します (個々のオブジェクト名またはグループオブジェクト名を持つことができます)。
object-type: は、object-name 属性で指定されたオブジェクト型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクト型は "category" になります)。
on-error: 同期エラーを警告またはエラーとして指定するかどうかを指定します。エラー時に使用できるオプション:
- 合計を警告として報告する
- 各項目を警告として報告する
- フェイルスクリプト
report-errors-to: フォルダーパスのみを指定し、TargetSynchronizationReport.XML という名前のファイルを作成する場合に、同期操作のエラーレポートの場所 (オプションの属性) を指定します。

構文の例:

<synchronize-target  
  
   object-name="<object-name>"  
  
   on-error="<report-total-as-warning/  
  
               report-each-as-warning/  
  
               fail-script>"   (optional)  
  
   report-errors-to="<file-name>"   (optional)  
  
/>

又は

<synchronize-target  
  
   object-name="<object-name>"  
  
  object-type="<object-category>"/>

又は

<synchronize-target>  
  
   <metabase-object object-name="<object-name>"/>  
  
   <metabase-object object-name="<object-name>"/>  
  
   <metabase-object object-name="<object-name>"/>  
  
</synchronize-target>

命令

データベースからリフレッシュ

データベースのソースオブジェクトを更新します。
このコマンドがターゲットデータベースに対して実行されると、エラーが生成されます。

スクリプト

object-name: ソースデータベースから更新対象と見なされるソースオブジェクトを指定します (個々のオブジェクト名またはグループオブジェクト名を持つことができます)。
object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクトの種類は "category" になります)。
on-error: 同期エラーを警告またはエラーとして指定するかどうかを指定します。エラー時に使用できるオプション:
- 合計を警告として報告する
- 各項目を警告として報告する
- フェイルスクリプト
report-errors-to: 同期操作のエラーレポートの場所を指定します（省略可能な属性）。フォルダーパスのみが指定されている場合、SourceDBRefreshReport.XMLという名前のファイルが作成されます。

コマンドラインパラメーターとして 1 つまたは複数のメタベースノードが必要です。

構文の例:

<refresh-from-database  
  
   object-name="<object-name>"  
  
   on-error="<report-total-as-warning/  
  
               report-each-as-warning/  
  
               fail-script>"   (optional)  
  
   report-errors-to="<file-name>"   (optional)  
  
/>

又は

<refresh-from-database  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"/>

又は

<refresh-from-database>  
  
   <metabase-object object-name="<object-name>"/>  
  
</refresh-from-database>

スクリプト生成スクリプトファイルのコマンド

スクリプト生成コマンドは、2 つのタスクを実行します。これらのタスクは、コンソール出力をスクリプトファイルに保存するのに役立ち、指定したパラメーターに基づいてコンソールまたはファイルに T-SQL 出力を記録します。

命令

スクリプトとして保存

metabase=target のときに言及されたファイルにオブジェクトのスクリプトを保存するために使用されます。これは同期コマンドの代わりに、スクリプトを取得し、ターゲットデータベースで同じものを実行します。

スクリプト

コマンドラインパラメーターとして 1 つまたは複数のメタベースノードが必要です。

object-name: スクリプトを保存するオブジェクトを指定します。 (個々のオブジェクト名またはグループオブジェクト名を持つことができます)
object-type: は、object-name 属性で指定されたオブジェクト型を指定します (オブジェクトカテゴリが指定されている場合、オブジェクト型は "category" になります)。
metabase: ソースメタベースかターゲットメタベースかを指定します。
destination: スクリプトを保存する必要があるパスまたはフォルダーを指定します。ファイル名が指定されていない場合は、ファイル名を形式 (object_name 属性値) で指定します。
overwrite: がtrue で、同じファイル名が存在する場合は上書きされます。値 (true/false) を指定できます。

構文の例:

<save-as-script  
  
   metabase="<source/target>"  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"  
  
   destination="<file-name/folder-name>"  
  
   overwrite="<true/false>"   (optional)  
  
/>

又は

<save-as-script  
  
   metabase="<source/target>"  
  
   destination="<file-name/folder-name>"  
  
      <metabase-object object-name="<object-name>"  
  
            object-type="<object-category>"/>  
  
</save-as-script>

命令

SQLステートメントを変換

context は、スキーマ名を指定します。
destination は、出力をファイルに格納するかどうかを指定します。

この属性が指定されていない場合は、変換された T-SQL ステートメントがコンソールに表示されます。 (省略可能な属性)
conversion-report-folder は、評価レポートが格納されているフォルダーを指定します。(省略可能な属性)
conversion-report-overwrite は、評価レポートフォルダーが既に存在する場合に上書きするかどうかを指定します。

既定値: false。 (省略可能な属性)
write-converted-sql-to は、変換された T-SQL が格納されるファイル (または) フォルダーのパスを指定します。 sql-files 属性と共にフォルダーパスを指定すると、各ソースファイルには、指定したフォルダーの下に対応するターゲット T-SQL ファイルが作成されます。 sql属性と共にフォルダーパスを指定すると、変換された T-SQL は、指定したフォルダーの下にある Result.out という名前のファイルに書き込まれます。
sql は、変換する MySQL sql ステートメントを指定します。1 つ以上のステートメントを ";" を使用して区切ることができます
sql-files は、T-SQL コードに変換する必要がある SQL ファイルのパスを指定します。
write-summary-report-to は、概要レポートが生成されるパスを指定します。フォルダーパスのみが指定されている場合は 、名前ConvertSQLReport.XML でファイルが作成されます。 (省略可能な属性)

レポートの作成には、さらに 2 つのサブカテゴリ (...) があります。
- report-errors (="true/false"、既定値は "false"（省略可能な属性）)。
- verbose（＝"true/false"。デフォルトは"false"。属性は省略可能です）。

スクリプト

コマンドラインパラメーターとして 1 つまたは複数のメタベースノードが必要です。

構文の例:

<convert-sql-statement  
  
   context="<schema-name>"  
  
   conversion-report-folder="<folder-name>"  
  
   conversion-report-overwrite="<true/false>"  
  
   write-summary-report-to="<file-name/folder-name>"   (optional)  
  
   verbose="<true/false>"   (optional)  
  
   report-errors="<true/false>"   (optional)  
  
   destination="stdout/file"   (optional)  
  
   write-converted-sql-to="<file-name/folder-name>"  
  
   sql="SELECT 1 FROM DUAL;">  
  
      <output-window suppress-messages="<true/false>" />  
  
</convert-sql-statement>

又は

<convert-sql-statement  
  
   context="<schema-name>"  
  
   conversion-report-folder="<folder-name>"  
  
   conversion-report-overwrite="<true/false>"  
  
   write-summary-report-to="<file-name/folder-name>"   (optional)  
  
   verbose="<true/false>"   (optional)  
  
   report-errors="<true/false>"   (optional)  
  
   destination="<stdout/file>"   (optional)  
  
   write-converted-sql-to="<file-name/folder-name>"  
  
   sql-files="<folder-name>\*.sql"  
  
/>

又は

<convert-sql-statement  
  
   context="<schema-name>"  
  
   conversion-report-folder="<folder-name>"  
  
   conversion-report-overwrite="<true/false>"  
  
   sql-files="<folder-name>\*.sql"  
  
/>

次の手順

コマンドラインオプションの詳細については、 SSMA コンソール (MySQLToSQL) のコマンドラインオプションを参照してください。

サンプルコンソールスクリプトファイルの詳細については、「サンプルコンソールスクリプトファイルの操作 (MySQLToSQL)」を参照してください。

次の手順は、プロジェクトの要件によって異なります。

パスワードの指定またはパスワードのエクスポート/インポートについては、「パスワードの管理 (MySQLToSQL)」を参照してください。
レポートの生成については、「レポートの生成 (MySQLToSQL)」を参照してください。
コンソールでの問題のトラブルシューティングについては、「トラブルシューティング (MySQLToSQL)」を参照してください。

次の方法で共有

SSMA コンソールの実行 (MySQLToSQL)

プロジェクト スクリプト ファイルのコマンド

データベース接続スクリプト ファイルのコマンド

レポート スクリプト ファイルのコマンド

移行スクリプト ファイルのコマンド

移行準備スクリプト ファイル コマンド

管理容易性スクリプト ファイルのコマンド

スクリプト生成スクリプト ファイルのコマンド

次の手順

フィードバック

その他のリソース

プロジェクトスクリプトファイルのコマンド

データベース接続スクリプトファイルのコマンド

レポートスクリプトファイルのコマンド

移行スクリプトファイルのコマンド

移行準備スクリプトファイルコマンド

管理容易性スクリプトファイルのコマンド

スクリプト生成スクリプトファイルのコマンド