Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Microsoft proporciona un conjunto sólido de comandos de archivo de script para ejecutar y controlar las actividades de SQL Server Migration Assistant (SSMA).
La aplicación de consola usa determinados comandos de archivo de script estándar como se enumera en esta sección.
Comandos Project de archivo de script
Comando create-new-project
Crea un nuevo proyecto de SSMA.
Los comandos proyect controlan la creación de proyectos, la apertura, el guardado y la salida de los proyectos.
Script
project-folder: indica la carpeta del proyecto que se crea.project-name: indica el nombre del proyecto. {string}overwrite-if-exists: atributo opcional. Indica si se debe sobrescribir un proyecto existente. {boolean}project-type: atributo opcional. Indica el tipo de proyecto, es decir,sql-server-2016,sql-server-2017,sql-server-2019,sql-server-2022,sql-server-2025osql-azure. El valor predeterminado essql-server-2016.
Ejemplo de sintaxis
<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-server-2025 | sql-azure>" (optional)
/>
El atributo overwrite-if-exists es false de forma predeterminada.
El atributo project-type es sql-server-2016 de forma predeterminada.
Comando open-project
Abre un proyecto existente.
Script
project-folderindica la carpeta del proyecto que se va a crear. Se produce un error en el comando si la carpeta especificada no existe. {string}project-nameindica el nombre del proyecto. Se produce un error en el comando si el proyecto especificado no existe. {string}
Ejemplo de sintaxis
<open-project
project-folder="<project-folder>"
project-name="<project-name>"
/>
Importante
La aplicación de consola SSMA for MySQL admite compatibilidad con versiones anteriores. Puede abrir proyectos creados por la versión anterior de SSMA.
Comando save-project
Guarda el proyecto de migración.
Ejemplo de sintaxis
<save-project/>
Comando close-project
Cierra el proyecto de migración.
Ejemplo de sintaxis
<save-project/>
O:
<close-project
if-modified="<save/error/ignore>" (optional)
/>
El atributo if-modified es opcional, ignore de forma predeterminada.
Comandos del archivo de script de conexión de base de datos
Los comandos Conexión de base de datos ayudan a conectarse a la base de datos.
La característica Examinar de la interfaz de usuario no se admite en la consola.
Los windows-authentication parámetros y port no son aplicables al conectarse a SQL Azure.
Para obtener más información, consulte Creación de archivos de script.
Comando connect-source-database
Realiza la conexión a la base de datos de origen y carga metadatos de alto nivel de la base de datos de origen, pero no todos los metadatos.
Si no se puede establecer la conexión al origen, se genera un error y la aplicación de consola detiene la ejecución.
Script
La definición del servidor se recupera del atributo de nombre definido para cada conexión, en la sección del servidor del archivo de conexión o archivo de script.
Ejemplo de sintaxis
<connect-source-database server="<server-unique-name>"/>
Comando force-load-source/target-database
Carga los metadatos de origen.
Es útil para trabajar en el proyecto de migración sin conexión.
Si no se puede establecer la conexión con el origen o destino, se genera un error y la aplicación de consola detiene la ejecución posterior.
Script
Requiere uno o varios nodos de metabase como parámetro de línea de comandos.
Ejemplo de sintaxis
<force-load metabase="<source/target>"
<metabase-object object-name="<object-name>"/>
</force-load>
Comando reconnect-source-database
Vuelve a conectarse a la base de datos de origen, pero no carga metadatos a diferencia del comando connect-source-database.
Si no se puede (re)conectar con el origen, se genera un error y la aplicación de consola detiene la ejecución.
Ejemplo de sintaxis
<reconnect-source-database server="<server-unique-name>"/>
Comando connect-target-database
Se conecta a SQL Server o Azure SQL Database de destino y carga metadatos de alto nivel de la base de datos de destino, pero no los metadatos por completo.
Si no se puede conectar con el destino, se genera un error y la aplicación de consola detiene la ejecución.
Script
La definición del servidor se recupera del atributo de nombre definido para cada conexión, en la sección del servidor del archivo de conexión o archivo de script.
Ejemplo de sintaxis
<connect-target-database server="<server-unique-name>"/>
Comando reconnect-target-database
Vuelve a conectarse a la base de datos de destino, pero no carga ningún metadato, a diferencia del comando connect-target-database.
Si no se puede (re)conectar con el destino, se genera un error y la aplicación de consola detiene la ejecución.
Ejemplo de sintaxis
<reconnect-target-database server="<server-unique-name>"/>
Comandos de archivo de script de informe
Los comandos Report generan informes sobre el rendimiento de diversas actividades de la consola de SSMA.
Comando generate-assessment-report
Genera informes de evaluación en la base de datos de origen.
Si no se realiza la conexión a la base de datos de origen antes de ejecutar este comando, se genera un error y se sale de la aplicación de consola.
Si no se conecta al servidor de bases de datos de origen durante la ejecución del comando, también se finaliza la aplicación de consola.
Script
assessment-report-folder: especifica la carpeta donde se almacena el informe de evaluación. (atributo opcional)object-name: especifica los objetos considerados para la generación de informes de evaluación (puede tener nombres de objeto individuales o un nombre de objeto de grupo).object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").assessment-report-overwrite: especifica si se va a sobrescribir la carpeta del informe de evaluación si ya existe.Valor predeterminado: false. (atributo opcional)
write-summary-report-to: especifica la ruta de acceso donde se genera el informe de resumen.Si solo se menciona la ruta de acceso de la carpeta, se crea el archivo por nombre
AssessmentReport<n>.xml. (atributo opcional)La creación de informes tiene dos subcategorías adicionales:
-
report-errors(="true/false", con el valor predeterminado como "false" (atributos opcionales)) -
verbose(="true/false", con el valor predeterminado como "false" (atributos opcionales))
-
Ejemplo de sintaxis
<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)
/>
O:
<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>
Comandos de archivo de script de migración
Los comandos de migración convierten el esquema de base de datos de destino en el esquema de origen y migra los datos al servidor de destino.
La configuración de salida de la consola predeterminada para los comandos de migración es el informe de salida "Completo" sin informes detallados de errores: solo resumen en el nodo raíz del árbol de objetos de origen.
Comando convert-schema
Hace la conversión de esquema desde el esquema de origen al de destino.
Si la conexión de base de datos de origen o de destino no se realiza antes de ejecutar este comando, o se produce un error en la conexión con el servidor de base de datos de origen o de destino durante la ejecución del comando, se genera un error y se cierra la aplicación de consola.
Script
conversion-report-folder: especifica la carpeta donde se almacena el informe de evaluación. (atributo opcional)object-name: especifica los objetos considerados para convertir el esquema (puede tener nombres de objeto individuales o un nombre de objeto de grupo).object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").conversion-report-overwrite: especifica si se va a sobrescribir la carpeta del informe de evaluación si ya existe.Valor predeterminado: false. (atributo opcional)
write-summary-report-to: especifica la ruta de acceso donde se genera el informe de resumen.Si solo se menciona la ruta de acceso de la carpeta, se crea el archivo por nombre
SchemaConversionReport<n>.xml. (atributo opcional)La creación de informes de resumen tiene dos subcategorías adicionales:
-
report-errors(="true/false", con el valor predeterminado como "false" (atributos opcionales)) -
verbose(="true/false", con el valor predeterminado como "false" (atributos opcionales))
-
Ejemplo de sintaxis
<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)
/>
O:
<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>
Comando migrate-data
Migra los datos de origen al destino.
Script
object-name: especifica los objetos de origen considerados para migrar datos (puede tener nombres de objeto individuales o un nombre de objeto de grupo).object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").write-summary-report-to: especifica la ruta de acceso donde se genera el informe de resumen.Si solo se menciona la ruta de acceso de la carpeta, se crea el archivo por nombre
DataMigrationReport<n>.xml. (atributo opcional)La creación de informes tiene dos subcategorías adicionales:
-
report-errors(="true/false", con el valor predeterminado como "false" (atributos opcionales)) -
verbose(="true/false", con el valor predeterminado como "false" (atributos opcionales))
-
Ejemplo de sintaxis
<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>
O:
<migrate-data
object-name="<object-name>"
object-type="<object-category>"
write-summary-report-to="<file-name/folder-name>"
report-errors="true" verbose="true"/>
Comando de archivo de script de preparación de migración
El comando Preparación de la migración inicia la asignación de esquemas entre las bases de datos de origen y de destino.
Comando map-schema
Mapeo de esquemas de la base de datos de origen al esquema objetivo.
Script
-
source-schemaespecifica el esquema de origen que pretendemos migrar. -
sql-server-schemaespecifica el esquema de destino en el que queremos que se migre.
Ejemplo de sintaxis
<map-schema
source-schema="<source-schema>"
sql-server-schema="<target-schema>"/>
Comandos de archivo de script de administración
Los comandos de administración ayudan a sincronizar los objetos de base de datos de destino con la base de datos de origen.
La configuración de salida de la consola predeterminada para los comandos de migración es el informe de salida "Completo" sin informes detallados de errores: solo resumen en el nodo raíz del árbol de objetos de origen.
Comando synchronize-target
Sincroniza los objetos de destino con la base de datos de destino.
Si este comando se ejecuta en la base de datos de origen, se produce un error.
Si la conexión de la base de datos de destino no se realiza antes de ejecutar este comando o se produce un error en la conexión con el servidor de base de datos de destino durante la ejecución del comando, se genera un error y se cierra la aplicación de consola.
Script
object-name: especifica los objetos considerados para la sincronización con la base de datos de destino (puede tener nombres de objeto individuales o un nombre de objeto de grupo).object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").on-error: especifica si se deben especificar errores de sincronización como advertencias o errores. Opciones disponibles para el error:report-total-as-warningreport-each-as-warningfail-script
report-errors-to: especifica la ubicación del informe de errores para la operación de sincronización (atributo opcional)Si solo se da la ruta de acceso de la carpeta, se crea un archivo por el nombre de
TargetSynchronizationReport.xml.
Ejemplo de sintaxis
<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)
/>
O:
<synchronize-target
object-name="<object-name>"
object-type="<object-category>"/>
O:
<synchronize-target>
<metabase-object object-name="<object-name>"/>
<metabase-object object-name="<object-name>"/>
<metabase-object object-name="<object-name>"/>
</synchronize-target>
Comando refresh-from-database
Actualiza los objetos de origen de la base de datos.
Si este comando se ejecuta en la base de datos de destino, se genera un error.
Script
object-name: especifica los objetos de origen que se consideran para actualizar desde la base de datos de origen (puede tener nombres de objeto individuales o un nombre de objeto de grupo).object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").on-error: especifica si se deben especificar errores de sincronización como advertencias o errores. Opciones disponibles para el error:report-total-as-warningreport-each-as-warningfail-script
report-errors-to: especifica la ubicación del informe de errores para la operación de sincronización (atributo opcional)Si solo se da la ruta de acceso de la carpeta, se crea un archivo por el nombre de
SourceDBRefreshReport.xml.
Requiere uno o varios nodos de metabase como parámetro de línea de comandos.
Ejemplo de sintaxis
<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)
/>
O:
<refresh-from-database
object-name="<object-name>"
object-type="<object-category>"/>
O:
<refresh-from-database>
<metabase-object object-name="<object-name>"/>
</refresh-from-database>
Comandos del archivo de generación de scripts
Los comandos de generación de scripts realizan tareas duales: ayudan a guardar la salida de la consola en un archivo de script; y registran la salida de T-SQL en la consola o en un archivo basado en el parámetro que especifique.
Comando save-as-script
Se usa para guardar los scripts de los objetos en un archivo mencionado cuando metabase=target. Se trata de una alternativa al comando de sincronización, en el que obtenemos los scripts y ejecutamos lo mismo en la base de datos de destino.
Script
Requiere uno o varios nodos de metabase como parámetro de línea de comandos.
object-name: especifica los objetos cuyos scripts se van a guardar. (Puede tener nombres de objeto individual o un nombre de objeto de grupo)object-type: especifica el tipo del objeto especificado en el atributo object-name (si se especifica la categoría de objeto, el tipo de objeto es "category").metabase: especifica si es el metabase de origen o de destino.destination: Especifica la ruta de acceso o la carpeta donde se debe guardar el script; si no se proporciona un nombre de archivo, entonces se usará un nombre de archivo en el formato (nombre_objeto "atributo valor").outoverwrite: si es true, sobrescribe si existe el mismo nombre de archivo. Puede tener los valores (true/false).
Ejemplo de sintaxis
<save-as-script
metabase="<source/target>"
object-name="<object-name>"
object-type="<object-category>"
destination="<file-name/folder-name>"
overwrite="<true/false>" (optional)
/>
O:
<save-as-script
metabase="<source/target>"
destination="<file-name/folder-name>"
<metabase-object object-name="<object-name>"
object-type="<object-category>"/>
</save-as-script>
Comando convert-sql-statement
contextespecifica el nombre del esquema.destinationespecifica si la salida debe almacenarse en un archivo.Si no se especifica este atributo, la instrucción T-SQL convertida se muestra en la consola. (atributo opcional)
conversion-report-folderespecifica la carpeta donde se almacena el informe de evaluación. (atributo opcional)conversion-report-overwriteespecifica si se va a sobrescribir la carpeta del informe de evaluación si ya existe.Valor predeterminado: false. (atributo opcional)
write-converted-sql-toespecifica la ruta de acceso de carpeta del archivo (o) donde se almacenará el T-SQL convertido. Cuando se especifica una ruta de acceso de carpeta junto con el atributosql-files, cada archivo de origen tiene un archivo T-SQL de destino correspondiente creado en la carpeta especificada. Cuando se especifica una ruta de acceso de carpeta junto con el atributosql, el T-SQL convertido se escribe en un archivo denominado Result.out dentro de la carpeta especificada.sqlespecifica las instrucciones sql de MySQL que se van a convertir, una o varias instrucciones se pueden separar mediante ";"sql-filesespecifica la ruta de acceso de los archivos sql que se deben convertir en código T-SQL.write-summary-report-toespecifica la ruta de acceso donde se genera el informe de resumen. Si solo se menciona la ruta de acceso de la carpeta, se crea el archivo por nombreConvertSQLReport.xml. (atributo opcional)La creación de informes tiene dos subcategorías adicionales:
-
report-errors(="true/false", con el valor predeterminado como "false" (atributos opcionales)). -
verbose(="true/false", con el valor predeterminado como "false" (atributos opcionales)).
-
Script
Requiere uno o varios nodos de metabase como parámetro de línea de comandos.
Ejemplo de sintaxis
<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>
O:
<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"
/>
O:
<convert-sql-statement
context="<schema-name>"
conversion-report-folder="<folder-name>"
conversion-report-overwrite="<true/false>"
sql-files="<folder-name>\*.sql"
/>