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

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

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

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

プロジェクト コマンド

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

create-new-project

このコマンドにより、新しい 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>"  
/>  

属性 '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>"  
  
/>  

save-project

このコマンドは、移行プロジェクトを保存します。

構文の例:

<save-project/>  

close-project

このコマンドは、移行プロジェクトを閉じます。

構文の例:

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

属性 'if-modified' はオプションであり、既定では無視されます。

データベース接続コマンド

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

connect-source-database

このコマンドは、ソース データベースへの接続を実行し、ソース データベースの高レベルのメタデータを読み込みますが、すべてのメタデータを読み込むわけではありません。

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

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

構文の例:

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

force-load-source/target-database

このコマンドはソース メタデータを読み込みます。これは、移行プロジェクトをオフラインで作業する場合に便利です。

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

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

構文の例:

<force-load metabase="<source/target>" >  
  
  <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: object-name 属性で呼び出されるオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクト型は "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-name/folder-name>"             (optional)  
  
  verbose="<true/false>"                       (optional)  
  
  report-errors="<true/false>"                 (optional)  
  
  assessment-report-folder="<folder-name>"          (optional)  
  
  conversion-report-overwrite="<true/false>"   (optional)  
  
/>  

or

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

移行コマンド

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

convert-schema

このコマンドは、ソースからターゲット スキーマへのスキーマ変換を実行します。

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

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

or

<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

このコマンドは、ソース データをターゲットに移行します。

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

or

<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>"/>  

管理容易性コマンド

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

synchronize-target

このコマンドは、ターゲット オブジェクトをターゲット データベースと同期します。

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

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

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

• object-type: object-name 属性で呼び出されるオブジェクトの型を指定します (オブジェクト カテゴリが指定されている場合、オブジェクト型は "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)  
  
/>  

or

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

or

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

or

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

or

<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: 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)  
  
/>  

or

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

convert-sql-statement

このコマンドは、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 は、変換する Sybase 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="<database-name>.<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>  

or

<convert-sql-statement  
  
         context="<database-name>.<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"  
  
/>  

or

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

次のステップ

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

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

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

• パスワードの指定またはパスワードのエクスポート/インポートについては、「パスワードの管理 (SybaseToSQL)」を参照してください。

• レポートの生成については、「レポートの生成 (SybaseToSQL)」を参照してください。

• コンソールでの問題のトラブルシューティングについては、「トラブルシューティング (SybaseToSQL)」を参照してください。