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

[アーティクル]
07/30/2024

マイクロソフトでは、SQL Server Migration Assistant (SSMA) アクティビティを実行および制御するための堅牢なスクリプトファイルコマンドやコマンドラインオプションのセットを提供しています。その後のセクションの詳細は同じです。

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

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

`create-new-project`

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

Attribute	規定値	説明	Type
`project-folder`	なし	作成されるプロジェクトのフォルダーを示します。	String
`project-name`	なし	プロジェクトの名前を示します。	String
`overwrite-if-exists`	`false`	オプションの属性は、既存のプロジェクトを上書きするかどうかを指定します。	Boolean
`project-type`	`sql-server-2008`	省略可能な属性です。 `project-type` では次のオプションを選択できます。 `sql-server-2005` `sql-server-2008` `sql-server-2012` `sql-server-2014` `sql-server-2016` `sql-azure`	String

構文の例

<create-new-project
  project-folder="<project-folder>"
  project-name="<project-name>"
  overwrite-if-exists="<true | false>"
  project-type="<project-type>"
/>

`open-project`

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

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

構文の例

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

Note

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

`save-project`

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

構文の例

<save-project/>

`close-project`

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

Attribute	規定値	説明	Type
`if-modified`	`ignore`	ビヘイビアーを指定する省略可能な属性。有効な値は `save`、`error`、`ignore` です。	String

構文の例

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

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

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

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

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

WINDOWS 認証とポート パラメーターは、SQL Azure に接続するときに適用されません。

詳しくは、「スクリプトファイルの作成 (AccessToSQL)」を参照してください。

`connect-source-database`

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

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

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

構文の例

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

`load-access-database`

データベースファイルへのアクセスを読み込む場合に使用します。

Attribute	規定値	説明	Type
`database-file`	なし	データベースへのアクセスのパスを指定します。	String

構文の例

<load-access-database  database-file="<Access-database>"/>

-または-

<load-access-database>
  <access-database database-file="<Access-database1>"/>
  <access-database database-file="<Access-database2>"/>
</load-access-database>

`force-load` ソースまたはターゲットデータベース

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

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

コマンドラインパラメーターとして 1 以上の metabase ノードが必要です。

Attribute	規定値	説明	Type
`object-name`	なし	オブジェクトの名前を指定します。	String
`metabase`	なし	データベースへのアクセスのパスを指定します。可能な値は `source` または `target` です。	String

構文の例

<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 コマンドとは異なり、メタデータは読み込まれません。

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

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

構文の例

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

`connect-target-database`

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

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

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

構文の例

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

`reconnect-target-database`

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

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

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

構文の例

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

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

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

`generate-assessment-report`

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

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

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

スクリプト

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="ssma.Procedures"
  object-type="category"
  write-summary-report-to="<file>"             (optional)
  verbose="<true/false>"                       (optional)
  report-errors="<true/false>"                 (optional)
  conversion-report-folder="<folder>"          (optional)
  conversion-report-overwrite="<true/false>"   (optional)
/>

-または-

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

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

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

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

`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="ssma.Procedures"
  object-type="category"
  write-summary-report-to="<filepath/folder>"     (optional)
  verbose="<true/false>"                          (optional)
  report-errors="<true/false>"                    (optional)
  conversion-report-folder="<folder>"             (optional)
  conversion-report-overwrite="<true/false>"      (optional)
/>

-または-

<convert-schema
  conversion-report-folder="<folder>"         (optional)
  conversion-report-overwrite="<true/false>"  (optional)
>
  <metabase-object object-name="ssma.Procedures"
    object-type="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="<filepath/folder>"
  report-errors="true" verbose="true">
    <metabase-object object-name="ssma.TT1"/>
    <metabase-object object-name="ssma.TT2"/>
    <metabase-object object-name="ssma.TT3"/>
    <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="ssma.Tables"
  object-type="category"
  write-summary-report-to="<filepath/folder>"
  report-errors="true" verbose="true"/>

`link-tables`

このコマンドは、ソース (アクセス) テーブルをターゲットテーブルにリンクします。

スクリプト

構文の例

<link-tables>
  <metabase-object object-name="AccessDatabase.table1" object-type="Tables"/>
  <metabase-object object-name="AccessDatabase.table2" object-type="Tables"/>
</link-tables>

-または-

<link-tables>
  <metabase-object object-name="AccessDatabase.Tables" object-type="category"/>
</link-tables>

`unlink-tables`

このコマンドは、ターゲットテーブルからソース (アクセス) テーブルのリンクを解除します。

スクリプト

構文の例:

<unlink-tables>
  <metabase-object object-name="AccessDatabase.table1" object-type="Tables"/>
  <metabase-object object-name="AccessDatabase.table2" object-type="Tables"/>
</unlink-tables>

-または-

<unlink-tables>
  <metabase-object object-name="AccessDatabase.Tables" object-type="category"/>
</unlink-tables>

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

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

`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="ots_triggers.dbo"
  on-error="<report-total-as-warning|
             report-each-as-warning|
             fail-script>"              (optional)
  report-errors-to="<file-name>"        (optional)
/>

-または-

<synchronize-target
  object-name="ssma.dbo.Procedures"
  object-type="category"/>

-または-

<synchronize-target>
  <metabase-object object-name="ssma.dbo.TT1"/>
  <metabase-object object-name="ssma.dbo.TT2"/>
  <metabase-object object-name="ssma.dbo.TT3"/>
</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="ssma.TT1"
  on-error="<report-total-as-warning|
             report-each-as-warning|
             fail-script>"              (optional)
  report-errors-to="<file-name>"        (optional)
/>

-または-

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

-または-

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

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

スクリプト生成コマンドは、コンソール出力をスクリプトファイルに保存するのに役立ちます。

`save-as-script`

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

スクリプト

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

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

構文の例

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

-または-

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

次の方法で共有

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

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

`create-new-project`

`open-project`

`save-project`

`close-project`

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

`connect-source-database`

`load-access-database`

`force-load` ソースまたはターゲットデータベース

`reconnect-source-database`

`connect-target-database`

`reconnect-target-database`

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

`generate-assessment-report`

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

`convert-schema`

`migrate-data`

`link-tables`

`unlink-tables`

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

`map-schema`

管理容易性コマンド

`synchronize-target`

`refresh-from-database`

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

`save-as-script`

フィードバック

その他のリソース

次の方法で共有

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

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

create-new-project

open-project

save-project

close-project

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

connect-source-database

load-access-database

force-load ソースまたはターゲット データベース

reconnect-source-database

connect-target-database

reconnect-target-database

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

generate-assessment-report

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

convert-schema

migrate-data

link-tables

unlink-tables

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

map-schema

管理容易性コマンド

synchronize-target

refresh-from-database

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

save-as-script

関連するコンテンツ

フィードバック

その他のリソース

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

`create-new-project`

`open-project`

`save-project`

`close-project`

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

`connect-source-database`

`load-access-database`

`force-load` ソースまたはターゲットデータベース

`reconnect-source-database`

`connect-target-database`

`reconnect-target-database`

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

`generate-assessment-report`

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

`convert-schema`

`migrate-data`

`link-tables`

`unlink-tables`

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

`map-schema`

`synchronize-target`

`refresh-from-database`

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

`save-as-script`