次の方法で共有

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

Microsoft では、SSMA アクティビティを実行および制御するための堅牢なスクリプト ファイル コマンドのセットを提供しています。 コンソール アプリケーションでは、このセクションで列挙されているように、特定の標準スクリプト ファイル コマンドを使用します。

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

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

create-new-project コマンド

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

スクリプト

  • project-folder: 作成されるプロジェクトのフォルダーを示します。

  • project-name: プロジェクトの名前を示します。 {string}

  • overwrite-if-exists: 省略可能な属性。 既存のプロジェクトを上書きするかどうかを示します。 {boolean}

  • project-type: 省略可能な属性。 プロジェクトの種類 ( sql-server-2016、 sql-server-2017、 sql-server-2019、 sql-server-2022、 sql-server-2025、または sql-azure) を示します。 既定値は sql-server-2016です。

構文の例

<create-new-project
   project-folder="<project-folder>"   project-name="<project-name>"
   overwrite-if-exists="<true/false>"   (optional)
   project-type="<sql-server-2016 | sql-server-2017 | sql-server-2019 | sql-server-2022 | sql-server-2025 | sql-azure>"   (optional)
/>

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

属性 project-type は既定で sql-server-2016 。

open-project コマンド

既存のプロジェクトを開きます。

スクリプト

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

  • project-name は、プロファイルの名前を示します。 指定したプロジェクトが存在しない場合、コマンドは失敗します。 {string}

構文の例

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

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

save-project コマンド

移行プロジェクトを保存します。

構文の例

<save-project/>

close-project コマンド

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

構文の例

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

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

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

UI の [Browse] (参照) 機能は、コンソールではサポートされていません。

詳細については、 スクリプト・ファイルの作成を参照してください。

connect-source-database コマンド

ソース データベースへの接続を実行し、ソース データベースの高度なメタデータを読み込みますが、すべてのメタデータを読み込むわけではありません。

ソースへの接続を確立できない場合は、エラーが生成され、コンソール アプリケーションはそれ以降の実行を停止します。

スクリプト

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

構文の例

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

force-load-source/target-database コマンド

ソース メタデータを読み込みます。

移行プロジェクトをオフラインで作業する場合に便利です。

ソース/ターゲットへの接続を確立できない場合は、エラーが生成され、コンソール アプリケーションはそれ以降の実行を停止します。

スクリプト

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

構文の例

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

または:

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

reconnect-source-database コマンド

ソース データベースに再接続しますが、connect-source-database コマンドとは異なり、メタデータは読み込まれません。

ソースとの (再) 接続を確立できない場合は、エラーが生成され、コンソール アプリケーションはそれ以降の実行を停止します。

構文の例

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

connect-target-database コマンド

ターゲット SQL Server データベースに接続し、ターゲット データベースの高レベルのメタデータを読み込みますが、メタデータ全体は読み込まれません。

ターゲットへの接続を確立できない場合は、エラーが生成され、コンソール アプリケーションはそれ以降の実行を停止します。

スクリプト

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

構文の例

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

reconnect-target-database コマンド

ターゲット データベースに再接続しますが、connect-target-database コマンドとは異なり、メタデータは読み込まれません。

ターゲットへの (再) 接続を確立できない場合は、エラーが生成され、コンソール アプリケーションはそれ以降の実行を停止します。

構文の例

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

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

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

generate-assessment-report コマンド

ソース データベースの評価レポートを生成します。

このコマンドを実行する前にソース データベース接続が実行されていない場合は、エラーが生成され、コンソール アプリケーションが終了します。

コマンドの実行中にソース データベース サーバーへの接続に失敗すると、コンソール アプリケーションも終了します。

スクリプト

  • conversion-report-folder: 評価レポートを格納できるフォルダーを指定します。 (オプションの属性)

  • object-name: 評価レポートの生成で考慮されるオブジェクトを指定します (個々のオブジェクト名またはグループ オブジェクト名を持つことができます)。

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "category" になります)。

  • conversion-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>"   (optional)
   verbose="<true/false>"   (optional)
   report-errors="<true/false>"   (optional)
   assessment-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" 出力レポートで、詳細なエラー 報告はなく、ソース オブジェクト ツリーのルート ノードの概要のみです。

convert-schema コマンド

ソースからターゲット スキーマへのスキーマ変換を実行します。

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

スクリプト

  • conversion-report-folder: 評価レポートを格納できるフォルダーを指定します。 (オプションの属性)

  • object-name: スキーマの変換対象と見なされるソース オブジェクトを指定します (個々のオブジェクト名またはグループ オブジェクト名を指定できます)。

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "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-name>"
         object-type="<object-category>"/>
</convert-schema>

migrate-data コマンド

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

スクリプト

  • conversion-report-folder: 評価レポートを格納できるフォルダーを指定します。 (オプションの属性)

  • object-name: データの移行対象と見なされるソース オブジェクトを指定します (個々のオブジェクト名またはグループ オブジェクト名を指定できます)。

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "category" になります)。

  • conversion-report-overwrite: 評価レポート フォルダーが既に存在する場合に上書きするかどうかを指定します。

    既定値: false (オプションの属性)

  • 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/false>"
   verbose="<true/false>">
      <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/false>"
   verbose="<true/false>"/>

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

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

map-schema コマンド

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

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

スクリプト

  • source-schema は、移行するソース スキーマを指定します。

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

構文の例

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

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

管理容易性コマンドは、ターゲット データベース オブジェクトをソース データベースと同期するのに役立ちます。 移行コマンドの既定のコンソール出力設定は "Full" 出力レポートで、詳細なエラー 報告はなく、ソース オブジェクト ツリーのルート ノードの概要のみです。

synchronize-target コマンド

ターゲット オブジェクトをターゲット データベースと同期します。

ソース データベースに対してこのコマンドを実行すると、エラーが発生します。

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

スクリプト

  • object-name: ターゲット データベースと同期すると見なされるターゲット オブジェクトを指定します (個々のオブジェクト名またはグループ オブジェクト名を持つことができます)。

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "category" になります)。

  • on-error: 同期エラーを警告またはエラーとして指定するかどうかを指定します。 on-error で使用できるオプション:

    • report-total-as-warning
    • report-each-as-warning
    • fail-script

  • 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/folder-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>

refresh-from-database コマンド

  • データベースのソース オブジェクトを更新します。

  • このコマンドがターゲット データベースに対して実行されると、エラーが生成されます。

スクリプト

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

  • object-name: ソース データベースから更新すると見なされるソース オブジェクトを指定します (個々のオブジェクト名またはグループ オブジェクト名を持つことができます)。

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "category" になります)。

  • on-error: 更新エラーを警告またはエラーとして指定するかどうかを指定します。 on-error で使用できるオプション:

    • report-total-as-warning

    • report-each-as-warning

    • fail-script

  • report-errors-to: 同期操作のエラー レポートの場所を指定します (省略可能な属性)

    フォルダー パスのみを指定すると、 SourceDBRefreshReport.xml の名前のファイルが作成されます。

構文の例

<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/folder-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 出力を記録します。

save-as-script コマンド

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

スクリプト

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

  • object-name: スクリプトを保存するオブジェクトを指定します。 (個々のオブジェクト名またはグループ オブジェクト名を持つことができます)

  • object-type: オブジェクト名属性で指定されたオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクトの種類は "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/folder>"
   overwrite="<true/false>"   (optional)
/>

または:

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

convert-sql-statement コマンド

  • 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 は、変換する Oracle 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)
   file-name="<file-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>"
   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" />

関連コンテンツ

  • Last updated on