執行 SSMA 控制台（Db2ToSQL）

Microsoft提供一組健全的腳本檔案命令，以執行和控制 SQL Server 移轉小幫手（SSMA）活動。後幾節會詳細說明相同的內容。主控台應用程式會使用本節列舉的特定標準指令檔命令。

專案指令檔命令

專案命令會處理建立專案、開啟、儲存和結束專案。

`create-new-project` 命令

建立新的 SSMA 專案。

Script

project-folder。指出專案建立的資料夾。
project-name。表示項目的名稱。 {string}
overwrite-if-exists。選擇性屬性。指出是否應該覆寫現有的專案。 {boolean}

`project-type` 命令

選擇性屬性。指出專案類型，即 sql-server-2016、 sql-server-2017sql-server-2019sql-server-2022sql-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-azure>"   (optional)
/>

屬性 overwrite-if-exists 預設為 false 。

屬性 project-type 預設為 sql-server-2016 。

`open-project` 命令

開啟現有專案。

Script

project-folder 表示專案建立的資料夾。如果指定的資料夾不存在，此命令就會失敗。 {string}
project-name 表示專案的名稱。如果指定的專案不存在，此命令就會失敗。 {string}

語法範例

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

SSMA for Db2 控制台應用程式支援回溯相容性。您可以開啟舊版 SSMA 所建立的專案。

`save-project` 命令

儲存移轉專案。

語法範例

<save-project/>

`close-project` 命令

關閉移轉專案。

語法範例

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

資料庫連接文稿檔案命令

資料庫連線命令可協助連線到資料庫。

主控台不支援 UI 的 [瀏覽] 功能。

如需詳細資訊，請參閱建立腳本檔案。

`connect-source-database` 命令

執行與來源資料庫的連線，並載入來源資料庫的高階中繼資料，但不會載入所有中繼資料。

如果無法建立至來源的連線，就會產生錯誤，而且主控台應用程式會停止進一步執行。

Script

伺服器定義是從伺服器連線檔或 Script 檔的伺服器區段中為每一個連線定義的 name 屬性擷取。

語法範例

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

`force-load-source-database`/`force-load-target-database`

載入來源中繼資料。

適合用於離線處理移轉專案。

如果無法建立來源/目標的連接，就會產生錯誤，主控台應用程式會停止進一步執行

Script

需要一或多個 Metabase 節點作為命令列參數。

語法範例

<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 資料庫，並載入目標資料庫的高階中繼資料，但不會完全載入中繼資料。

如果無法建立至目標的連線，就會產生錯誤，而且主控台應用程式會停止進一步執行。

Script

erver 定義是從伺服器連線檔或指令碼檔的伺服器區段中為每一個連線定義的 name 屬性擷取

語法範例

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

`reconnect-target-database`

重新連線至目標資料庫，但不會載入任何中繼資料，與 connect-target-database 命令不同。

如果無法建立至目標的 (重新) 連線，就會產生錯誤，主控台應用程式會停止進一步執行。

語法範例

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

報告指令檔命令

[報表] 命令會產生各種 SSMA 控制台活動的效能報告。

`generate-assessment-report`

在來源資料庫上產生評定報告。

如果在執行此命令之前未執行來源資料庫連線，則會產生錯誤，而且主控台應用程式會結束。

在命令執行期間無法連線到來源資料庫伺服器，也會導致終止主控台應用程式。

Script

conversion-report-folder：指定可儲存評量報告的資料夾。 (選用屬性)
object-name：指定產生評量報告時考慮的物件（可以具有個別物件名稱或群組物件名稱）。
object-type：指定 object-name 屬性中指定的物件類型（如果指定了物件類別，則物件類型為 category）。
conversion-report-overwrite：指定是否要覆寫評量報告資料夾（如果該資料夾已存在）。

預設值：false。 (選用屬性)
write-summary-report-to：指定產生摘要報告的路徑。

如果只提及資料夾路徑，則會依名稱 AssessmentReport<n>.XML 建立檔案。 (選用屬性)

報告建立有兩個更進一步的子類別：
- 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>

移轉指令檔命令

移轉命令會將目標資料庫結構描述轉換成來源結構描述，並將資料移轉至目標伺服器。移轉命令的預設主控台輸出設定是「完整」輸出報告，沒有詳細的錯誤報告：只有來源物件樹狀目錄根節點的摘要。

`convert-schema`

執行從來源到目標結構描述的結構描述轉換。

如果在執行此命令之前未執行來源或目標資料庫連線，或在命令執行期間與來源或目標資料庫伺服器的連線失敗，則會產生錯誤，且主控台應用程式會結束。

Script

conversion-report-folder：指定可儲存評量報告的資料夾。 (選用屬性)
object-name：指定考慮轉換結構描述的來源物件（它可以具有個別物件名稱或群組物件名稱）。
object-type：指定 object-name 屬性中指定的物件類型（如果指定了物件類別，則物件類型為 category）。
conversion-report-overwrite：指定是否要覆寫評量報告資料夾（如果該資料夾已存在）。

預設值：false。 (選用屬性)
write-summary-report-to：指定產生摘要報告的路徑。

如果只提及資料夾路徑，則會依名稱 SchemaConversionReport<n>.XML 建立檔案。 (選用屬性)

報告建立有兩個更進一步的子類別：
- 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` 命令

將來源資料移轉至目標。

Script

conversion-report-folder：指定可儲存評量報告的資料夾。 (選用屬性)
object-name：指定考慮移轉資料的來源物件（可以具有個別物件名稱或群組物件名稱）。
object-type：指定 object-name 屬性中指定的物件類型（如果指定了物件類別，則物件類型為 category）。
conversion-report-overwrite：指定是否要覆寫評量報告資料夾（如果該資料夾已存在）。

預設值：false。 (選用屬性)
write-summary-report-to：指定產生摘要報告的路徑。

如果只提及資料夾路徑，則會依名稱 DataMigrationReport<n>.xml 建立檔案。 (選用屬性)

報告建立有兩個更進一步的子類別：
- 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>"/>

`map-schema` 命令

來源資料庫到目標模式的模式對應。

Script

source-schema 指定我們想要移轉的來源結構描述。

sql-server-schema 指定我們想要移轉至的目標結構描述。

語法範例

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

管理性腳本檔案命令

管理性命令可協助同步處理目標資料庫物件與來源資料庫。

移轉命令的預設主控台輸出設定是「完整」輸出報告，沒有詳細的錯誤報告：只有來源物件樹狀目錄根節點的摘要。

`synchronize-target` 命令

同步目標物件與目標資料庫。

如果針對來源資料庫執行此命令，就會發生錯誤。

如果在執行此命令之前未執行目標資料庫連線，或在命令執行期間與目標資料庫伺服器的連線失敗，則會產生錯誤，且主控台應用程式會結束。

Script

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

或：

<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` 命令

從資料庫重新整理來源物件。

如果針對目標資料庫執行此命令，會產生錯誤。

Script

需要一或多個 Metabase 節點作為命令列參數。

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

或：

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

或：

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

腳本產生腳本檔案命令

指令碼產生命令會執行雙重工作：它們可協助將主控台輸出儲存在指令檔中，並根據您指定的參數，將 T-SQL 輸出記錄到主控台或檔案。

`save-as-script` 命令

用於將物件的腳本儲存到提到 metabase=target的檔案中。這是同步命令的替代方法，我們在其中獲取腳本並在目標數據庫上執行相同的腳本。

Script

需要一或多個 Metabase 節點作為命令列參數。

object-name：指定要儲存其指令碼的物件。 (其可有個別物件名稱或群組物件名稱)
object-type：指定 object-name 屬性中指定的物件類型（如果指定了物件類別，則物件類型為 category）。
metabase：指定它是來源或目標資料庫。
destination：指定必須儲存指令碼的路徑或資料夾，若未指定檔案名稱，則會使用格式為（object_name 屬性值).out 的檔案名稱。
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 指定要轉換的 Db2 SQL 語句，可以使用 “;” 分隔一或多個語句
sql-files 指定必須轉換成 T-SQL 程式碼的 SQL 檔案路徑。
write-summary-report-to 會指定產生報表的路徑。如果只提及資料夾路徑，則會依名稱 ConvertSQLReport.xml 建立檔案。 (選用屬性)

報告建立有兩個更進一步的子類別：
- report-errors： true 或 false，預設值為 false （選擇性屬性）
- verbose： true 或 false，預設值為 false （選擇性屬性）

Script

需要一或多個 Metabase 節點作為命令列參數。

語法範例

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

平行執行 SSMA 主控台

SSMA 主控台公用程式可以透過腳本平行執行，方法是將資料庫名稱和對應的資料夾路徑指定為輸入參數。在下列範例中，資料庫 SAMPLE1、 SAMPLE2和 SAMPLE3及其各自的資料夾路徑會作為指令碼的輸入提供。

SAMPLE1,C:\folder path\SSMA Project1
SAMPLE2,C:\folder path\SSMA Project2
SAMPLE3,C:\folder path\SSMA Project3

下列範例 PowerShell 腳本可啟用 SSMA 主控台的平行執行。

$baseFolder = "C:\folder path\folder1"
$ssmaExe = "C:\folder path\SSMAforDb2Console.exe"
$databaselistPath = Join-Path $baseFolder "Databaselist.txt"
$conversionXmlTemplate = Join-Path $baseFolder "ConversionAndDataMigrationSample.xml"
$variableXmlTemplate = Join-Path $baseFolder "VariableValueFileSample.xml"

# Read all entries
$entries = Get-Content $databaselistPath | Where-Object { $_.Trim() -ne "" }

# Prepare the entries
$preparedEntries = foreach ($entry in $entries) {
    $parts = $entry -split ","
    $dbName = $parts[0].Trim()
    $workingFolder = $parts[1].Trim()
    if ($dbNameCounts.ContainsKey($dbName)) {
        $dbNameCounts[$dbName]++
        $suffix = "_{0:D2}" -f $dbNameCounts[$dbName]
        $fileDbName = "$dbName$suffix"
    }
    else {
        $dbNameCounts[$dbName] = 0
        $fileDbName = $dbName
    }
    [PSCustomObject]@{
        DbName        = $dbName
        WorkingFolder = $workingFolder
        FileDbName    = $fileDbName
    }
}

# Run in parallel
$preparedEntries | ForEach-Object -Parallel {
    $dbName = $_.DbName
    $workingFolder = $_.WorkingFolder
    $fileDbName = $_.FileDbName

    # Update ConversionAndDataMigrationSample.xml
    $convTree = [xml](Get-Content $using:conversionXmlTemplate)
    $convTree.SelectNodes("//initial-catalog") | ForEach-Object { $_.SetAttribute("value", $dbName) }
    $conversionXmlPath = Join-Path $using:baseFolder "ConversionAndDataMigrationSample_$fileDbName.xml"
    $convTree.Save($conversionXmlPath)

    # Update VariableValueFileSample.xml
    $varTree = [xml](Get-Content $using:variableXmlTemplate)
    $nodes = $varTree.SelectNodes('//variable[@name="$WorkingFolder$"]')
    if ($nodes.Count -eq 0) {
        Write-Host "No variable node found for `$WorkingFolder$"
    }
    else {
        $nodes | ForEach-Object { $_.value = $workingFolder }
    }
    $nodes2 = $varTree.SelectNodes('//variable[@name="$Db2InitialCatalog$"]')
    if ($nodes2.Count -eq 0) {
        Write-Host "No variable node found for `$Db2InitialCatalog$"
    }
    else {
        $nodes2 | ForEach-Object { $_.value = $dbName }
    }
    $variableXmlPath = Join-Path $using:baseFolder "VariableValueFileSample_$fileDbName.xml"
    $varTree.Save($variableXmlPath)

    # Prepare output/error file paths
    $outputFile = Join-Path $using:baseFolder "ssma_output_$fileDbName.txt"
    $errorFile = Join-Path $using:baseFolder "ssma_error_$fileDbName.txt"

    # Prepare argument list
    $arguments = "-s `"$conversionXmlPath`" -v `"$variableXmlPath`""

    # Run SSMA console
    Start-Process -FilePath $using:ssmaExe -ArgumentList $arguments -RedirectStandardOutput $outputFile -RedirectStandardError $errorFile -Wait
    Write-Host "Executed command: `"$using:ssmaExe`" $arguments"
}

意見反應

此頁面對您有幫助嗎？

Last updated on 2025-11-12

共用方式為

執行 SSMA 控制台 （Db2ToSQL）

專案指令檔命令

create-new-project 命令

Script

project-type 命令

語法範例

open-project 命令

Script

語法範例

save-project 命令

語法範例

close-project 命令

語法範例

資料庫連接文稿檔案命令

connect-source-database 命令

Script

語法範例

force-load-source-database/force-load-target-database

Script

語法範例

reconnect-source-database

語法範例

connect-target-database

Script

語法範例

reconnect-target-database

語法範例

報告指令檔命令

generate-assessment-report

Script

語法範例

移轉指令檔命令

convert-schema

Script

語法範例

migrate-data 命令

Script

語法範例

移轉準備腳本檔案命令

map-schema 命令

source-schema 命令

sql-server-schema 命令

語法範例

map-schema 命令

Script

語法範例

管理性腳本檔案命令

synchronize-target 命令

Script

語法範例

refresh-from-database 命令

Script

語法範例

腳本產生腳本檔案命令

save-as-script 命令

Script

語法範例

convert-sql-statement 命令

Script

語法範例

平行執行 SSMA 主控台

相關內容

意見反應

其他資源

執行 SSMA 控制台（Db2ToSQL）

`create-new-project` 命令

`project-type` 命令

`open-project` 命令

`save-project` 命令

`close-project` 命令

`connect-source-database` 命令

`force-load-source-database`/`force-load-target-database`

`reconnect-source-database`

`connect-target-database`

`reconnect-target-database`

`generate-assessment-report`

`convert-schema`

`migrate-data` 命令

`map-schema` 命令

`source-schema` 命令

`sql-server-schema` 命令

`map-schema` 命令

`synchronize-target` 命令

`refresh-from-database` 命令

`save-as-script` 命令

`convert-sql-statement` 命令