執行 SSMA 主控台 (MySQLToSQL)

發行項
08/21/2023

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

重要

SSMA For MySQL 主控台應用程式支援回溯相容性。您將能夠開啟舊版 SSMA 所建立的專案。

命令

save-project：儲存移轉專案。

指令碼

語法範例：

<save-project/>

命令

close-project
：關閉移轉專案。

指令碼

語法範例：

<save-project/>

命令

close-project
：關閉移轉專案。

指令碼

語法範例：

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

「if-modified」屬性是選用的，預設為忽略。

資料庫連線指令檔命令

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

主控台不支援 UI 的 [瀏覽] 功能。
連線到 SQL Azure 時，不適用 windows-authentication 和 port參數。
如需「建立指令檔」的詳細資訊，請參閱建立指令檔 (MySQLToSQL)。

命令

connect-source-database

執行與來源資料庫的連線，並載入來源資料庫的高階中繼資料，但不會載入所有中繼資料。
如果無法建立至來源的連線，就會產生錯誤，而且主控台應用程式會停止進一步執行

指令碼

伺服器定義是從伺服器連接檔或指令檔的伺服器區段中，針對每個連接所定義的 name 屬性擷取。

語法範例：

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

命令

force-load-source/target-database

載入來源中繼資料。
適合用於離線處理移轉專案。
如果無法建立至來源/目標的連線，就會產生錯誤，而且主控台應用程式會停止進一步執行。

指令碼

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

語法範例：

<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 或 Azure SQL Database，並載入目標資料庫的高階中繼資料，但不會完全載入中繼資料。
如果無法建立至目標的連線，就會產生錯誤，而且主控台應用程式會停止進一步執行。

指令碼

伺服器定義是從伺服器連接檔或指令檔的伺服器區段中，針對每個連接所定義的 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

在來源資料庫上產生評定報告。
如果在執行此命令之前未執行來源資料庫連線，則會產生錯誤，而且主控台應用程式會結束。
在命令執行期間無法連線到來源資料庫伺服器，也會導致終止主控台應用程式。

指令碼

assessment-report-folder: 指定儲存評量報告的資料夾。(選用屬性)
object-name: 指定考慮評量報告產生的物件 (其可有個別物件名稱或群組物件名稱)。
object-type: 指定 object-name 屬性中指定的物件類型 (如果指定物件類別目錄，則物件類型會是「category」)。
assessment-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-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>

移轉指令檔命令

移轉命令會將目標資料庫結構描述轉換成來源結構描述，並將資料移轉至目標伺服器。

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

命令

convert-schema

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

指令碼

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-names>"  
  
         object-type="<object-category>"/>  
  
</convert-schema>

命令

migrate-data

將來源資料移轉至目標。

指令碼

object-name: 指定考慮移轉資料的來源物件 (其可有個別物件名稱或群組物件名稱)。
object-type: 指定 object-name 屬性中指定的物件類型 (如果指定物件類別目錄，則物件類型會是「category」)。
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" 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"/>

移轉準備指令檔命令

移轉準備命令會起始來源與目標資料庫之間的結構描述對應。

命令

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

從資料庫重新整理來源物件。
如果針對目標資料庫執行此命令，會產生錯誤。

指令碼

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 建立檔案。

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

語法範例：

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

指令碼產生指令檔命令

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

命令

save-as-script

用於將物件的指令碼儲存到 metabase=target 時提及的檔案，這是同步處理命令的替代方法，我們會在其中取得指令碼並在目標資料庫上執行相同的指令碼。

指令碼

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

object-name: 指定要儲存其指令碼的物件。 (其可有個別物件名稱或群組物件名稱)
object-type: 指定 object-name 屬性中指定的物件類型 (如果指定物件類別目錄，則物件類型會是「category」)。
metabase: 指定它是來源或目標 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-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>

命令

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 指定要轉換的 MySQL sql 陳述式，可以使用「;」分隔一個或多個陳述式
sql-files 指定必須轉換成 T-SQL 程式碼的 sql 檔案路徑。
write-summary-report-to 指定產生摘要報告的路徑。如果只提及資料夾路徑，則會以名稱 ConvertSQLReport.XML 建立檔案。 (選用屬性)

報告建立有兩個進一步的子類別，即：
- report-errors (=「true/false」，預設值為「false」(選用屬性))。
- verbose (=「true/false」，預設值為「false」 (選用屬性))。

指令碼

需要一個或多個 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)  
  
   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)

專案指令檔命令

資料庫連線指令檔命令

報告指令檔命令

移轉指令檔命令

移轉準備指令檔命令

管理性指令檔命令

指令碼產生指令檔命令

後續步驟

意見反應

其他資源