Edit

Share via

Executing the SSMA Console (MySQLToSQL)

  • Article

Microsoft provides you with a robust set of script file commands to execute and control SSMA activities.

The console application uses certain standard script file commands as enumerated in this section.

Project Script File Commands

Command

create-new-project:
Creates a new SSMA project.

The Project commands handle creating projects, opening, saving, and exiting projects.

Script

  1. project-folder indicates the folder of the project getting created.

  2. project-name indicates the name of the project. {string}

  3. overwrite-if-existsOptional attribute indicates if an existing project should be overwritten. {boolean}

  4. project-type:Optional attribute. Indicates the project type i.e. "sql-server-2005" project or "sql-server-2008" project or "sql-server-2012" or "sql-server-2014" project or "sql-azure" project. Default is "sql-server-2008".

Syntax Example:

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

Attribute 'overwrite-if-exists' is false by default.

Attribute 'project-type' is sql-server-2008 by default.

Command

open-project:
Opens an existing project.

Script

  1. project-folder indicates the folder of the project getting created. The command fails if the specified folder does not exist. {string}

  2. project-name indicates the name of the project. The command fails if the specified project does not exist. {string}

Syntax Example:

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

Important

SSMA For MySQL Console Application supports backward compatibility. You will be able to open projects created by previous version of SSMA.

Command

save-project: Saves the migration project.

Script

Syntax Example:

<save-project/>

Command

close-project
: Closes the migration project.

Script

Syntax Example:

<save-project/>

Command

close-project
: Closes the migration project.

Script

Syntax Example:

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

Attribute 'if-modified' is optional, ignore by default.

Database Connection Script File Commands

The Database Connection commands help connect to the database.

  1. The Browse feature of the UI is not supported in console.

  2. The windows-authentication and port parameters are not applicable when connecting to SQL Azure.

  3. For more information on 'Creating Script Files', see Creating Script Files (MySQLToSQL).

Command

connect-source-database

  • Performs connection to the source database and loads high-level metadata of the source database but not all of the metadata.

  • If the connection to the source cannot be established, an error is generated and the console application stops further execution

Script

Server definition is retrieved from the name attribute defined for each connection in the server section of the server connection file or the script file.

Syntax Example:

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

Command

force-load-source/target-database

  • Loads the source metadata.

  • Useful for working on migration project offline.

  • If the connection to the source/target cannot be established, an error is generated and the console application stops further execution

Script

Requires one or several metabase nodes as command-line parameter.

Syntax Example:

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

Command

reconnect-source-database

  1. Reconnects to the source database but does not load any metadata unlike the connect-source-database command.

  2. If (re)connection with the source cannot be established, an error is generated and the console application stops further execution.

Script

Syntax Example:

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

Command

connect-target-database

  1. Connects to the target SQL Server or Azure SQL Database and loads high-level metadata of the target database but not the metadata entirely.

  2. If the connection to the target cannot be established, an error is generated and the console application stops further execution.

Script

Server definition is retrieved from the name attribute defined for each connection in the server section of the server connection file or the script file

Syntax Example:

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

Command

reconnect-target-database

  1. Reconnects to the target database but does not load any metadata, unlike the connect-target-database command.

  2. If (re)connection to the target cannot be established, an error is generated and the console application stops further execution.

Script

Syntax Example:

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

Report Script File Commands

The Report commands generate reports on the performance of various SSMA Console activities.

Command

generate-assessment-report

  1. Generates assessment reports on the source database.

  2. If the source database connection is not performed before executing this command, an error is generated and the console application exits.

  3. Failure to connect to the source database server during the command execution, also results in terminating the console application.

Script

  1. assessment-report-folder: Specifies folder where the assessment report is stored.(optional attribute)

  2. object-name: Specifies the object(s) considered for assessment report generation (It can have individual object names or a group object name).

  3. object-type: specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  4. assessment-report-overwrite: Specifies whether to overwrite the assessment report folder if it already exists.

    Default value: false. (optional attribute)

  5. write-summary-report-to: Specifies the path where the summary report will be generated.

    If only the folder path is mentioned, then file by name AssessmentReport<n>.XML is created. (optional attribute)

    Report creation has two further sub-categories:

    • report-errors (="true/false", with default as "false" (optional attributes))

    • verbose (="true/false", with default as "false" (optional attributes))

Syntax Example:

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

or

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

Migration Script File Commands

The Migration commands convert the target database schema to the source schema and migrates data to the target server.

The default console output setting for the migration commands is 'Full' output report with no detailed error reporting: Only summary at the source object tree root node.

Command

convert-schema

  1. Performs schema conversion from source to the target schema.

  2. If the source or target database connection is not performed before executing this command or the connection to the source or target database server fails during the command execution, an error is generated and the console application exits.

Script

  1. conversion-report-folder: Specifies folder where the assessment report is stored.(optional attribute)

  2. object-name: Specifies the object(s) considered for converting schema (It can have individual object names or a group object name).

  3. object-type: specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  4. conversion-report-overwrite: Specifies whether to overwrite the assessment report folder if it already exists.

    Default value: false. (optional attribute)

  5. write-summary-report-to: Specifies the path where the summary report will be generated.

    If only the folder path is mentioned, then file by name SchemaConversionReport<n>.XML is created. (optional attribute)

    Summary report creation has two further sub-categories:

    • report-errors (="true/false", with default as "false" (optional attributes))

    • verbose (="true/false", with default as "false" (optional attributes))

Syntax Example:

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

Command

migrate-data

  1. Migrates the source data to the target.

Script

  1. object-name: Specifies the source object(s) considered for migrating data (It can have individual object names or a group object name).

  2. object-type: specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  3. write-summary-report-to: Specifies the path where the summary report will be generated.

    If only the folder path is mentioned, then file by name DataMigrationReport<n>.XML is created. (optional attribute)

    Report creation has two further sub-categories:

    • report-errors (="true/false", with default as "false" (optional attributes))

    • verbose (="true/false", with default as "false" (optional attributes))

Syntax Example:

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

or

<migrate-data  
  
   object-name="<object-name>"  
  
   object-type="<object-category>"  
  
   write-summary-report-to="<file-name/folder-name>"  
  
   report-errors="true" verbose="true"/>

Migration Preparation Script File Command

The Migration Preparation command initiates schema mapping between the source and target databases.

Command

map-schema

Schema mapping of source database to the target schema.

Script

  1. source-schema specifies the source schema we intend to migrate.

  2. sql-server-schema specifies the target schema where we want it to be migrated.

Syntax Example:

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

Manageability Script File Commands

The Manageability commands help synchronize the target database objects with the source database.

Note

The default console output setting for the migration commands is 'Full' output report with no detailed error reporting: Only summary at the source object tree root node.

Command

synchronize-target

  1. Synchronizes the target objects with the target database.

  2. If this command is executed against the source database, an error is encountered.

  3. If the target database connection is not performed before executing this command or the connection to the target database server fails during the command execution, an error is generated and the console application exits.

Script

  1. object-name: Specifies the object(s) considered for synchronizing with target database (It can have individual object names or a group object name).

  2. object-type: specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  3. on-error: Specifies whether to specify synchronization errors as warnings or error. Available options for on-error:

    • report-total-as-warning

    • report-each-as-warning

    • fail-script

  4. report-errors-to: Specifies location of error report for the synchronization operation (optional attribute) if only folder path is given, then file by name TargetSynchronizationReport.XML is created.

Syntax Example:

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

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>

Command

refresh-from-database

  1. Refreshes the source objects from database.

  2. If this command is executed against the target database, an error is generated.

Script

  1. object-name: Specifies the source object(s) considered for refreshing from source database (It can have individual object names or a group object name).

  2. object-type: Specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  3. on-error: Specifies whether to specify synchronization errors as warnings or error. Available options for on-error:

    • report-total-as-warning

    • report-each-as-warning

    • fail-script

  4. report-errors-to: Specifies location of error report for the synchronization operation (optional attribute) if only folder path is given, then file by name SourceDBRefreshReport.XML is created.

Requires one or several metabase nodes as command-line parameter.

Syntax Example:

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

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>

Script Generation Script File Commands

The Script Generation commands perform dual tasks: They help save the console output in a script file; and record the T-SQL output to the console or a file based on the parameter you specify.

Command

save-as-script

Used to save the Scripts of the objects to a file mentioned when metabase=target ,this is an alternative to synchronization command where in we get the scripts and execute the same on the target database.

Script

Requires one or several metabase nodes as command-line parameter.

  1. object-name: Specifies the object(s) whose scripts are to be saved . (It can have individual object names or a group object name)

  2. object-type: specifies the type of the object specified in the object-name attribute (if object category is specified then object type will be "category").

  3. metabase: Specifies whether it is the source or target metabase.

  4. destination: Specifies the path or the folder where the script has to be saved, if the file name is not given then a file name in the format (object_name attribute value).out

  5. overwrite: if true then it overwrites if same filename exist. It can have the values (true/false).

Syntax Example:

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

Command

convert-sql-statement

  1. context specifies the schema name.

  2. destination specifies whether the output should be stored in a file.

    If this attribute is not specified, then the converted T-SQL statement is displayed on the console. (optional attribute)

  3. conversion-report-folder specifies folder where the assessment report is stored.(optional attribute)

  4. conversion-report-overwrite specifies whether to overwrite the assessment report folder if it already exists.

    Default value: false. (optional attribute)

  5. write-converted-sql-to specifies the file (or) folder path where the converted T-SQL is to be stored. When a folder path is specified along with the sql-files attribute, each source file will have a corresponding target T-SQL file created under the specified folder. When a folder path is specified along with the sql attribute, the converted T-SQL is written to a file named Result.out under the specified folder.

  6. sql specifies the MySQL sql statements to be converted, one or more statements can be separated using a ";"

  7. sql-files specifies the path of the sql files which has to be converted to T-SQL code.

  8. write-summary-report-to specifies the path where the summary report will be generated. If only the folder path is mentioned, then file by name ConvertSQLReport.XML is created. (optional attribute)

    Report creation has 2 further sub-categories, viz..,:

    • report-errors (="true/false", with default as "false" (optional attributes)).

    • verbose (="true/false", with default as "false" (optional attributes)).

Script

Requires one or several metabase nodes as command-line parameter.

Syntax Example:

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

or

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

or

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

Next Step

For information on command-line options, see command-line Options in SSMA Console (MySQLToSQL) .

For more information on Sample console script files, see Working with the Sample Console Script Files (MySQLToSQL)

The next step depends on your project requirements:

  1. For specifying a password or export/ import passwords, see Managing Passwords (MySQLToSQL).

  2. For generating reports, see Generating Reports (MySQLToSQL).

  3. For troubleshooting issues in console, see Troubleshooting (MySQLToSQL).