Referencia de la CLI para AWS Schema Conversion Tool - AWS Schema Conversion Tool

Referencia de la CLI para AWS Schema Conversion Tool

En esta sección, se describe cómo comenzar a utilizar la interfaz de la línea de comandos (CLI) de AWS SCT. Además, en esta sección se proporciona información sobre los comandos de teclado y los modos de uso. Para obtener más información sobre los comandos de la CLI de AWS SCT, consulte Material de referencia.

Requisitos previos para usar la interfaz de la línea de comandos de AWS SCT

Descargue e instale la versión más reciente de Amazon Corretto 11. Para obtener más información, consulte Descargas para Amazon Corretto 11 en la Guía del Usuario de Amazon Corretto 11.

Descargue e instale la última versión de AWS SCT. Para obtener más información, consulte Instalación de AWS Schema Conversion Tool.

Modo interactivo de la CLI de AWS SCT

Puede utilizar la interfaz de la línea de comandos de AWS SCT en el modo interactivo. En este modo, los comandos se introducen en la consola uno a uno. Puede usar este modo interactivo para obtener más información sobre los comandos de la CLI o descargar los escenarios de la CLI más utilizados.

Para convertir el esquema de la base de datos de origen enAWS SCT, ejecute una operación secuencial: cree un proyecto nuevo, conéctese a las bases de datos de origen y destino, cree reglas de asignación y convierta los objetos de la base de datos. Como este flujo de trabajo puede ser complejo, recomendamos usar scripts en el modo de la CLI de AWS SCT. Para obtener más información, consulte Modo script.

Puede ejecutar los comandos de la CLI de AWS SCT desde la carpeta app de la ruta de instalación de AWS SCT. En Windows, la ruta de instalación predeterminada es C:\Program Files\AWS Schema Conversion Tool\. Asegúrese de que esta carpeta incluya el archivo AWSSchemaConversionToolBatch.jar.

Para accede al modo interactivo de la CLI de AWS SCT, utilice el siguiente comando después de completar los requisitos previos.

java -jar AWSSchemaConversionToolBatch.jar -type interactive

Ahora puede ejecutar los comandos de la CLI de AWS SCT. Asegúrese de terminar los comandos con / en una línea nueva. Además, debe utilizar comillas simples rectas (') antes y después de los valores de los parámetros de los comandos.

nota

Si el comando anterior devuelve un Unexpected error, pruebe lo siguiente:

java -Djdk.jar.maxSignatureFileSize=20000000 -jar AWSSchemaConversionToolBatch.jar

Para ver la lista de comandos disponibles en el modo interactivo de la CLI de AWS SCT, ejecute el siguiente comando.

help /

Para ver información sobre un comando de CLI de AWS SCT, utilice el siguiente comando.

help -command: 'command_name' /

En el ejemplo anterior, sustituya command_name por el nombre de un comando.

Para ver información sobre los parámetros de un comando de CLI de AWS SCT, utilice el siguiente comando.

help -command: 'command_name' -parameters: 'parameters_list' /

En el ejemplo anterior, sustituya command_name por el nombre de un comando. A continuación, sustituya parameters_list por una lista de nombres de parámetros separados por una coma.

Para ejecutar un script desde un archivo en el modo interactivo de la CLI de AWS SCT, utilice el siguiente comando.

ExecuteFile -file: 'file_path' /

En el ejemplo anterior, sustituya file_path por la ruta del archivo con un script. El archivo debe tener la extensión .scts.

Para salir del modo interactivo de la CLI de AWS SCT, ejecute el comando quit.

Ejemplos

En el siguiente ejemplo se muestra información sobre el comando Convert.

help -command: 'Convert' /

En el siguiente ejemplo se muestra información sobre los parámetros del comando Convert.

help -command: 'Convert' -parameters: 'filter, treePath' /

Obtención de escenarios de la CLI de AWS SCT

Para obtener los escenarios de AWS SCT más utilizados, puede usar el comando GetCliScenario. Puede ejecutar este comando en modo interactivo y, a continuación, editar las plantillas descargadas. Utilice los archivos editados en modo script.

El comando GetCliScenario guarda la plantilla seleccionada o todas las plantillas disponibles en el directorio especificado. La plantilla contiene el conjunto completo de comandos para ejecutar un script. Edite las rutas de los archivos, las credenciales de la base de datos, los nombres de los objetos y otros datos de estas plantillas. Además, asegúrese de eliminar los comandos que no utilice y de añadir nuevos comandos al script cuando sea necesario.

Para ejecutar el comando GetCliScenario, complete los requisitos previos y acceda al modo interactivo de la CLI de AWS SCT. Para obtener más información, consulte Modo interactivo.

A continuación, utilice la siguiente sintaxis para ejecutar el comando GetCliScenario y obtener los escenarios de AWS SCT.

GetCliScenario -type: 'template_type' -directory: 'file_path' /

En el ejemplo anterior, sustituya template_type por uno de los tipos de plantilla de la tabla siguiente. A continuación, sustituya file_path por la ruta de la carpeta en la que desee descargar los scripts. Compruebe que AWS SCT pueda acceder a esta carpeta sin solicitar derechos de administrador. Además, debe utilizar comillas simples rectas (') antes y después de los valores de los parámetros de los comandos.

Para descargar todas las plantillas de la CLI de AWS SCT, ejecute el comando anterior sin la opción -type.

En la tabla siguiente, se incluyen los tipos de plantillas de la CLI de AWS SCT que puede descargar. Para cada plantilla, se incluye en la tabla el nombre del archivo y la descripción de las operaciones que se pueden ejecutar mediante el script.

Tipo de plantilla Nombre de archivo Descripción

BTEQScriptConversion

BTEQScriptConversionTemplate.scts

Convierte los scripts de Basic Teradata Query (BTEQ), FastExport, FastLoad y MultiLoad de Teradata a RSQL de Amazon Redshift. Para obtener más información, consulte Conversión de datos mediante ETL.

ConversionApply

ConversionTemplate.scts

Convierte los esquemas de la base de datos de origen y aplica el código convertido a la base de datos de destino. Si lo desea, guarda el código convertido como un script de SQL y guarda el informe de evaluación. Para obtener más información, consulte Conversión de esquemas.

GenericAppConversion

GenericApplicationConversionTemplate.scts

Convierte el código SQL incrustado en sus aplicaciones con el conversor de aplicaciones genérico de AWS SCT. Para obtener más información, consulte Código SQL.

HadoopMigration

HadoopMigrationTemplate.scts

Migra sus clústeres de Hadoop en las instalaciones a Amazon EMR. Para obtener más información, consulte Conexión a las bases de datos de Apache Hadoop con AWS Schema Conversion Tool.

HadoopResumeMigration

HadoopResumeMigrationTemplate.scts

Reanuda una migración interrumpida del clúster de Hadoop en las instalaciones a Amazon EMR. Para obtener más información, consulte Conexión a las bases de datos de Apache Hadoop con AWS Schema Conversion Tool.

Informatica

InformaticaConversionTemplate.scts

Convierte el código SQL incrustado en los scripts de extracción, transformación y carga (ETL) de Informatica. Configura las conexiones a las bases de datos de origen y destino en los scripts de ETL y guarda los scripts convertidos tras la conversión. Para obtener más información, consulte Scripts de ETL de Informatica.

LanguageSpecificAppConversion

LanguageSpecificAppConversionTemplate.scts

Convierte el código SQL incrustado en sus aplicaciones de C#, C++, Java y Pro*C con el conversor de aplicaciones de AWS SCT. Para obtener más información, consulte Conversión de SQL de las aplicaciones.

OozieConversion

OozieConversionTemplate.scts

Convierte sus flujos de trabajo de Apache Oozie a AWS Step Functions. Para obtener más información, consulte Conexión a los flujos de trabajo de Apache Oozie con AWS Schema Conversion Tool.

RedshiftAgent

DWHDataMigrationTemplate.scts

Convierte los esquemas de almacenamiento de datos de origen y aplica el código convertido a la base de datos de Amazon Redshift de destino. A continuación, registra un agente de extracción de datos, crea e inicia una tarea de migración de datos. Para obtener más información, consulte Migración desde un almacenamiento de datos.

ReportCreation

ReportCreationTemplate.scts

Crea un informe de migración de bases de datos para varios esquemas de bases de datos de origen. A continuación, guarda este informe como un archivo CSV o PDF. Para obtener más información, consulte Informes de evaluación.

SQLScriptConversion

SQLScriptConversionTemplate.scts

Convierte los scripts de SQL*Plus o TSQL a PL/SQL y guarda los scripts convertidos. Además, guarda un informe de evaluación.

Tras descargar la plantilla de la CLI de AWS SCT, utilice el editor de texto para configurar el script para que se ejecute en las bases de datos de origen y destino. A continuación, utilice el modo de script de CLI de AWS SCT para ejecutar el script. Para obtener más información, consulte Modo script de CLI de AWS SCT.

Ejemplos

En el siguiente ejemplo, se descargan todas las plantillas a la carpeta C:\SCT\Templates.

GetCliScenario -directory: 'C:\SCT\Templates' /

En el siguiente ejemplo, se descarga la plantilla para la operación ConversionApply a la carpeta C:\SCT\Templates.

GetCliScenario -type: 'ConversionApply' -directory: 'C:\SCT\Templates' /

Edición de escenarios de la CLI de AWS SCT

Después de descargar las plantillas de escenarios, configúrelas para obtener scripts funcionales que puedan ejecutarse en sus bases de datos.

Para todas las plantillas, asegúrese de proporcionar la ruta a los controladores de las bases de datos de origen y destino. Para obtener más información, consulte Instalación de controladores JDBC para AWS Schema Conversion Tool.

Debe incluir las credenciales de las bases de datos de origen y destino. Además, debe configurar reglas de asignación para describir un par origen-destino para su proyecto de conversión. Para obtener más información, consulte Asignación de tipos de datos.

A continuación, configure el alcance de las operaciones que se van a ejecutar. Puede eliminar los comandos que no utilice o añadir nuevos comandos al script.

Por ejemplo, supongamos que planea convertir todos los esquemas de la base de datos Oracle de origen a PostgreSQL. A continuación, tiene pensado guardar el informe de evaluación de la migración de la base de datos en formato PDF y aplicar el código convertido a la base de datos de destino. En este caso, puede utilizar la plantilla para la operación ConversionApply. Utilice el siguiente procedimiento para editar la plantilla de la CLI de AWS SCT.

Para editar la plantilla de la CLI de AWS SCT para la operación ConversionApply
  1. Abra el ConversionTemplate.scts que descargó. Para obtener más información, consulte Ejemplos.

  2. Elimine las operaciones CreateFilter, Convert -filter, ApplyToTarget -filter, SaveTargetSQL, SaveTargetSQLbyStatement y SaveReportCSV de su script.

  3. En oracle_driver_file, en la operación SetGlobalSettings, introduzca la ruta a su controlador de Oracle. A continuación, en postgresql_driver_file, introduzca la ruta al controlador de PostgreSQL.

    Si utiliza otros motores de bases de datos, utilice los nombres correspondientes para la configuración. Para obtener una lista completa de las configuraciones globales que puede establecer en la operación SetGlobalSettings, consulte la Matriz de configuración global en Material de referencia.

  4. (Opcional) En CreateProject, introduzca el nombre de su proyecto y la ubicación del archivo de proyecto local. Si decide continuar con los valores predeterminados, asegúrese de que AWS SCT pueda crear archivos en la carpeta C:\temp sin solicitar derechos de administrador.

  5. En AddSource, introduzca la dirección IP del servidor de base de datos de origen. Introduzca también el nombre de usuario, la contraseña y el puerto para conectarse al servidor de base de datos de origen.

  6. En AddTarget, introduzca la dirección IP del servidor de base de datos de destino. Introduzca también el nombre de usuario, la contraseña y el puerto para conectarse al servidor de base de datos de destino.

  7. (Opcional) Para AddServerMapping, introduzca los objetos de base de datos de origen y destino que desee agregar a una regla de asignación. Puede utilizar los parámetros sourceTreePath y targetTreePath para especificar la ruta a los objetos de la base de datos. Si lo desea, puede utilizar sourceNamePath y targetNamePath para especificar los nombres de los objetos de la base de datos. Para más información, consulte Comandos de asignación de servidor en la Material de referencia.

    Los valores predeterminados de la operación AddServerMapping asignan todos los esquemas de origen a la base de datos de destino.

  8. Guarde el archivo y, a continuación, utilice el modo script para ejecutarlo. Para obtener más información, consulte Modo script.

Modo script de CLI de AWS SCT

Tras crear un script de CLI de AWS SCT o editar una plantilla, puede ejecutarlo con el comando RunSCTBatch. Guarde el archivo con el script de CLI como extensión .scts.

Puede ejecutar los scripts de CLI de AWS SCT desde la carpeta app de la ruta de instalación de AWS SCT. En Windows, la ruta de instalación predeterminada es C:\Program Files\AWS Schema Conversion Tool\. Asegúrese de que esta carpeta incluya el archivo RunSCTBatch.cmd o RunSCTBatch.sh. Además, esta carpeta debe incluir el archivo AWSSchemaConversionToolBatch.jar.

Como alternativa, puede añadir la ruta al archivo RunSCTBatch en la variable de entorno PATH de su sistema operativo. Tras actualizar la variable de entorno PATH, puede ejecutar scripts de CLI de AWS SCT desde cualquier carpeta.

Para ejecutar un script de CLI de AWS SCT, utilice el siguiente comando en Windows.

RunSCTBatch.cmd --pathtoscts "file_path"

En el ejemplo anterior, sustituya file_path por la ruta del archivo con un script.

Para ejecutar un script de CLI de AWS SCT, utilice el siguiente comando en Linux.

RunSCTBatch.sh --pathtoscts "file_path"

En el ejemplo anterior, sustituya file_path por la ruta del archivo con un script.

Puede proporcionar parámetros opcionales en este comando, como las credenciales de la base de datos, el nivel de detalles de la salida de la consola y otros. Para obtener más información, descargue la referencia de la interfaz de la línea de comandos de AWS SCT comandos en Material de referencia.

Ejemplos

En el ejemplo siguiente se ejecuta el script de ConversionTemplate.scts en la carpeta C:\SCT\Templates. Puede usar este ejemplo en Windows.

RunSCTBatch.cmd --pathtoscts "C:\SCT\Templates\ConversionTemplate.scts"

En el ejemplo siguiente se ejecuta el script de ConversionTemplate.scts en el directorio /home/user/SCT/Templates. Puede usar este ejemplo en Linux.

RunSCTBatch.sh --pathtoscts "/home/user/SCT/Templates/ConversionTemplate.scts"

Material de referencia de la CLI de AWS SCT

Puede encontrar material de referencia sobre la interfaz de la línea de comandos (CLI) de AWS Schema Conversion Tool en la siguiente guía: Referencia de la CLI de AWS Schema Conversion Tool.