AWS Schema Conversion Tool. User Guide Version 1.0

Transcription

1 AWS Schema Conversion Tool User Guide

2 AWS Schema Conversion Tool: User Guide Copyright 2016 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

3 Table of Contents What Is the AWS Schema Conversion Tool?... 1 Converting Your Schema... 2 AWS Schema Conversion Tool Project Window... 3 Related Topics... 4 Installing and Updating... 5 Installing the AWS Schema Conversion Tool on Windows... 6 Installing the AWS Schema Conversion Tool on Mac OS X... 6 Installing the AWS Schema Conversion Tool on Ubuntu Linux... 6 Installing the AWS Schema Conversion Tool on Fedora Linux... 7 Updating the AWS Schema Conversion Tool... 7 Required Database Drivers... 7 Installing JDBC Drivers on Linux... 7 Updating Global Settings... 8 Related Topics... 9 Getting Started Before You Begin Step 1: Create an AWS Schema Conversion Tool Project Step 2: View the Schema from Your Source Database Step 3: Create the Schema Step 4: Clear the Schema Step 5: Update Your Source Schema Step 6: Overwrite the Schema Step 7: Create the Database Migration Assessment Report Step 8: Apply the Schema to the DB Instance Related Topics Converting Schema Create a Project Microsoft SQL Server as the Source MySQL as the Source Oracle as the Source PostgreSQL as the Source Related Topics Creating and Using the Assessment Report Creating a Database Migration Assessment Report Related Topics Converting Your Schema Editing Schema Clearing a Schema Related Topics Updating and Refreshing Your Schema Related Topics Saving and Applying Your Schema Saving Your Schema to a File Applying Your Schema Related Topics Related Topics Best Practices Memory Management and Performance Related Topics Reference Related Topics Oracle to MySQL Supported Schema Conversion Statements Procedures Flow Control iii

4 Packages Functions Operators Data Types Data Definition Language (DDL) Cursors Hints Exceptions Related Topics Microsoft SQL Server to PostgreSQL Supported Schema Conversion Data Definition Language (DDL) Data Manipulation Language (DML) Data Types Database Mail Functions Operators Other Service Broker SQL Server Agent SQL Server Backup T-SQL Microsoft SQL Server to PostgreSQL Conversion Issue Reference SQL Server to MySQL Supported Schema Conversion Statements Procedures Flow Control Functions Operators Transactions Data Types Data Definition Language (DDL) Cursors Related Topics Keyboard Shortcuts Related Topics Troubleshooting Cannot load objects from an Oracle source database Related Topics Document History iv

5 What Is the AWS Schema Conversion Tool? The AWS Schema Conversion Tool helps you convert your existing database schema to a schema suitable for an Amazon Relational Database Service (Amazon RDS) MySQL DB instance, an Amazon Aurora DB cluster, or an Amazon RDS PostgreSQL DB instance. The AWS Schema Conversion Tool supports the following conversions. Source Database Microsoft SQL Server MySQL Oracle PostgreSQL Target Database on Amazon RDS Amazon Aurora, MySQL, PostgreSQL PostgreSQL Amazon Aurora, MySQL, PostgreSQL Amazon Aurora, MySQL te You can migrate data from MySQL to an Amazon Aurora DB cluster without the AWS Schema Conversion Tool. For more information, see Migrating Data to an Amazon Aurora DB Cluster. 1

6 Converting Your Schema Converting Your Schema The AWS Schema Conversion Tool provides a project-based user interface to automatically convert the database schema of your source database into a format compatible with your target Amazon RDS instance. If schema from your source database cannot be automatically converted, the AWS Schema Conversion Tool provides guidance on how you can create equivalent schema in your target Amazon RDS database. For information about how to install the AWS Schema Conversion Tool, see Installing and Updating the AWS Schema Conversion Tool (p. 5). The following is a general outline of the steps to convert your database schema to Amazon RDS: 1. Create your target DB instance. 2. Create a new AWS Schema Conversion Tool project. 3. Connect the AWS Schema Conversion Tool to your source and target. 4. Create a database migration assessment report. 5. Convert your schema. 2

7 AWS Schema Conversion Tool Project Window 6. Apply the converted schema to Amazon RDS. 7. Create any schema elements that couldn't be automatically converted. For more details about each step, see Converting a Database Schema to Amazon RDS Using the AWS Schema Conversion Tool (p. 31). For an example that walks you through how to use the AWS Schema Conversion Tool, see Getting Started with the AWS Schema Conversion Tool (p. 10). AWS Schema Conversion Tool Project Window The following is what you see in the AWS Schema Conversion Tool when you create a schema migration project. 1. In the left panel, the schema from your source database is presented in a tree view. Your database schema is "lazy loaded." In other words, when you select an item from the tree view, the AWS Schema Conversion Tool gets and displays the current schema from your source database. 3

8 Related Topics 2. In the top middle panel, action items appear for schema elements from the source database engine that couldn't be automatically converted to the target database engine. 3. In the right panel, the schema from your target DB instance is presented in a tree view.your database schema is "lazy loaded." That is, at the point when you select an item from the tree view, the AWS Schema Conversion Tool gets and displays the current schema from your target database. 4. In the lower left panel, when you choose a schema element, properties describing the source schema element and the SQL command to create that element in the source database are displayed. 5. In the lower right panel, when you choose a schema element, properties describing the target schema element and the SQL command to create that element in the target database are displayed. You can edit this SQL command and save the updated command with your project. Related Topics Best Practices for the AWS Schema Conversion Tool (p. 60) 4

9 Installing and Updating the AWS Schema Conversion Tool The AWS Schema Conversion Tool is available for the following operating systems: Microsoft Windows (download) Mac OS X (download) Ubuntu Linux (download) Fedora Linux (download) te The AWS Schema Conversion Tool is supported only on 64-bit operating systems. The AWS Schema Conversion Tool also installs the Java Runtime Environment (JRE) version 8u45. Topics Important After you install the AWS Schema Conversion Tool, you must also install the required Java Database Connectivity (JDBC) drivers to connect to your source database and target Amazon Relational Database Service (Amazon RDS) DB instance. For details, see Required Database Drivers (p. 7). Installing the AWS Schema Conversion Tool on Windows (p. 6) Installing the AWS Schema Conversion Tool on Mac OS X (p. 6) Installing the AWS Schema Conversion Tool on Ubuntu Linux (p. 6) Installing the AWS Schema Conversion Tool on Fedora Linux (p. 7) Updating the AWS Schema Conversion Tool (p. 7) Required Database Drivers (p. 7) Related Topics (p. 9) 5

10 Installing the AWS Schema Conversion Tool on Windows Installing the AWS Schema Conversion Tool on Windows To install the AWS Schema Conversion Tool on Microsoft Windows 1. Download aws-schema-conversion-tool-1.0.latest.zip for Windows, and then extract AWS Schema Conversion Tool-1.0.msi. 2. Run the AWS Schema Conversion Tool-1.0.msi installer. By default, the AWS Schema Conversion Tool is installed in the c:\program Files\AWS Schema Conversion Tool folder. 3. When the installation is complete, you can run the AWS Schema Conversion Tool application. Install the required JDBC drivers for your source database engine and target DB instance database engine, if needed, and set the paths to the JDBC drivers in the global settings of the AWS Schema Conversion Tool. For details, see Required Database Drivers (p. 7). Installing the AWS Schema Conversion Tool on Mac OS X To install the AWS Schema Conversion Tool on Mac OS X 1. Download aws-schema-conversion-tool-1.0.latest.zip for Mac OS X, and then extract AWS Schema Conversion Tool-1.0.dmg. 2. In Finder, open AWS Schema Conversion Tool-1.0.dmg. 3. Drag AWS Schema Conversion Tool-1.0.dmg to the Applications folder. 4. When the installation is complete, you can run the AWS Schema Conversion Tool application. Install the required JDBC drivers for your source database engine and target DB instance database engine, if needed, and set the paths to the JDBC drivers in the global settings of the AWS Schema Conversion Tool. For details, see Required Database Drivers (p. 7). Installing the AWS Schema Conversion Tool on Ubuntu Linux Important The AWS Schema conversion tool is supported on Ubuntu Linux version (64-bit). To install the AWS Schema Conversion Tool on Ubuntu Linux 1. Download aws-schema-conversion-tool-1.0.latest.zip for Ubuntu, and then extract aws-schema-conversion-tool-1.0.deb. 2. Run the following command, where file-path is the folder that you downloaded the file to: sudo dpkg -i file-path/aws-schema-conversion-tool-1.0.deb 3. When the installation is complete, you can run the AWS Schema Conversion Tool application. Install the required JDBC drivers for your source database engine and target DB instance database engine, if needed, and set the paths to the JDBC drivers in the global settings of the AWS Schema Conversion Tool. For details, see Required Database Drivers (p. 7). 6

11 Installing the AWS Schema Conversion Tool on Fedora Linux Installing the AWS Schema Conversion Tool on Fedora Linux Important The AWS Schema conversion tool is supported on Fedora Linux version 22 (64-bit). To install the AWS Schema Conversion Tool on Fedora Linux 1. Download aws-schema-conversion-tool-1.0.latest.zip for Fedora, and then extract aws-schema-conversion-tool x86_64.rpm. 2. Run the following command, where file-path is the folder that you downloaded the file to: sudo yum install file-path/aws-schema-conversion-tool x86_64.rpm 3. When the installation is complete, you can run the AWS Schema Conversion Tool application. Install the required JDBC drivers for your source database engine and target DB instance database engine, if needed, and set the paths to the JDBC drivers in the global settings of the AWS Schema Conversion Tool. For details, see Required Database Drivers (p. 7). Updating the AWS Schema Conversion Tool To check whether new version of the AWS Schema Conversion Tool is available, choose Help, and then choose Check for Updates. If there is a newer version of the AWS Schema Conversion Tool than the version that you have installed, you are prompted to download and install the updated version. Required Database Drivers You must have the required JDBC drivers installed for the AWS Schema Conversion Tool to connect to your source database or target RDS DB instance. You can download the latest database drivers from the following locations. Database Engine Amazon Aurora Microsoft SQL Server MySQL Oracle Download Driver versions 7 and later are supported. PostgreSQL Installing JDBC Drivers on Linux You can use the following steps to install the JDBC drivers on your Linux system for use with the AWS Schema Conversion Tool. 7

12 Updating Global Settings To install JDBC drivers on your Linux system 1. Create a directory to store the JDBC drivers in. PROMPT>sudo mkdir p /usr/local/jdbc-drivers 2. Install the JDBC driver for your database engine using the commands shown following. Database Engine Amazon Aurora Installation Commands PROMPT> cd /usr/local/jdbc-drivers PROMPT> sudo tar xzvf /tmp/mysql-connector-java- X.X.X.tar.gz Microsoft SQL Server PROMPT> cd /usr/local/jdbc-drivers PROMPT> sudo tar xzvf /tmp/sqljdbc_x.x.x_enu.tar.gz MySQL PROMPT> cd /usr/local/jdbc-drivers PROMPT> sudo tar xzvf /tmp/mysql-connector-java- X.X.X.tar.gz Oracle PROMPT> cd /usr/local/jdbc-drivers PROMPT> sudo mkdir oracle-jdbc PROMPT> cd oracle-jdbc PROMPT> sudo cp -a /tmp/ojdbc7.jar. PostgreSQL PROMPT> cd /usr/local/jdbc-drivers PROMPT> sudo cp -a /tmp/postgresql-x.x.x.jre7.tar. Updating Global Settings After you have downloaded and installed the required JDBC drivers, you must update the settings in the AWS Schema Conversion Tool with the driver file locations. To update the driver file locations 1. In the AWS Schema Conversion Tool, choose Settings, and then choose Global Settings. 8

13 Related Topics 2. For Global settings, choose Drivers. Add the file path to the JDBC driver for your source database engine and your target RDS DB instance database engine. 3. Choose OK to exit the Global settings window. Related Topics What Is the AWS Schema Conversion Tool? (p. 1) Getting Started with the AWS Schema Conversion Tool (p. 10) 9

14 Before You Begin Getting Started with the AWS Schema Conversion Tool Following, we walk you through how to create an AWS Schema Conversion Tool project and convert the schema from your source database to your target Amazon Relational Database Service (Amazon RDS) DB instance. The AWS Schema Conversion Tool supports the following conversions. Source Database Microsoft SQL Server MySQL Oracle PostgreSQL Target Database on Amazon RDS Amazon Aurora, MySQL, PostgreSQL PostgreSQL Amazon Aurora, MySQL, PostgreSQL Amazon Aurora, MySQL Before You Begin Before you perform the tasks described in this topic, you must first complete the following tasks: Install the AWS Schema Conversion Tool. For more information, see Installing and Updating the AWS Schema Conversion Tool (p. 5). Identify the connection information for your source database. Create your target Amazon RDS DB instance, if needed, and identify the connection information for your target DB instance. For more information, see the following documentation. Database Engine Amazon Aurora Relevant Documentation Creating an Amazon Aurora DB Cluster Connecting to an Amazon Aurora DB Cluster MySQL Creating a DB Instance Running the MySQL Database Engine Connecting to a DB Instance Running the MySQL Database Engine 10

15 Step 1: Create an AWS Schema Conversion Tool Project Database Engine PostgreSQL Relevant Documentation Creating a DB Instance Running the PostgreSQL Database Engine Connecting to a DB Instance Running the PostgreSQL Database Engine Step 1: Create an AWS Schema Conversion Tool Project The first time that you open the AWS Schema Conversion Tool, you automatically begin creating a database migration project using the Create New Database Migration Project wizard. You can create additional projects using the Create New Database Migration Project wizard by choosing New Project Wizard from the File menu. Optionally, you can create a project without the Create New Database Migration Project wizard by choosing New Project from the File menu. For more information, see Creating an AWS Schema Conversion Tool Project (p. 33). To create a database migration project using the Create New Database Migration Project wizard 1. Choose File, and then choose New Project Wizard. The wizard opens and the page Step1: Select Source appears. 11

16 Step 1: Create an AWS Schema Conversion Tool Project 2. On the page Step1: Select Source, add your local project settings and database connection information. Use the instructions shown following in the table for your source database engine. Microsoft SQL Server Source Database For This Parameter Project Name Location Source DB Engine Server Name Server Port Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose SQL Server. Type the Domain Name Service (DNS) name or IP address of your source database server. Type the port used to connect to your source database server. 12

17 Step 1: Create an AWS Schema Conversion Tool Project For This Parameter Instance name Username and Password Use SSL Do This Type the instance name for the SQL Server database. To find the instance name, run the query SELECT on your SQL Server database. Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. Select this option if you want to use Secure Sockets Layer (SSL) to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: Trust Server Certificate: Select this option to trust the server certificate. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. Sql Server Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). MySQL Source Database For This Parameter Project Name Location Source DB Engine Server Name Server Port Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose MySQL. Type the DNS name or IP address of your source database server. Type the port used to connect to your source database server. 13

18 Step 1: Create an AWS Schema Conversion Tool Project For This Parameter Username and Password Use SSL Do This Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. Select this option if you want to use SSL to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: Require SSL: Select this option if you want to connect to the server only through SSL. te If you choose Require SSL, it means that if the server doesn't support SSL, you can't connect to the server. If you don't choose Require SSL and the server doesn't support SSL, you can still connect to the server without using SSL. For more information, see Using Secure Connections. Verify Server Certificate: Select this option to verify the server certificate using a trust store. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. MySql Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). Oracle Source Database For This Parameter Project Name Location Source DB Engine Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose Oracle. 14

19 Step 1: Create an AWS Schema Conversion Tool Project For This Parameter Type Do This Choose the connection type to your database. Depending on your type, provide the following additional information: SID Server Name: The DNS name or IP address of your source database server. Server Port: The port used to connect to your source database server. Oracle SID: The Oracle System ID (SID). To find the Oracle SID, submit the following query to your Oracle database: SELECT sys_context('userenv','instance_name') AS SID FROM dual; Service Name Server Name: The DNS name or IP address of your source database server. Server Port: The port used to connect to your source database server. Service Name: The name of the Oracle service to connect to. TNS Alias TNS file path: The path to the file that contains the Transparent Network Substrate (TNS) name connection information. TNS file path: The TNS alias from this file to use to connect to the source database. TNS Connect Identifier TNS identifier: The identifier for the registered TNS connection information. Username and Password Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. 15

20 Step 1: Create an AWS Schema Conversion Tool Project For This Parameter Use SSL Do This Select this option if you want to use SSL to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: SSL Authentication: Select this option to use SSL authentication for the connection. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. Key Store: The location of a key store containing a private key and certificates. This value is required if SSL Authentication is selected and is otherwise optional. Trust Store Password: The password for the key store. This value is required if SSL Authentication is selected and is otherwise optional. Oracle Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). PostgreSQL Source Database For This Parameter Project Name Location Source DB Engine Server Name Server Port Database Username and Password Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose PostgreSQL. Type the DNS name or IP address of your source database server. Type the port used to connect to your source database server. Type the name of the PostgreSQL database. Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. 16

21 Step 1: Create an AWS Schema Conversion Tool Project For This Parameter Use SSL Do This Select this option if you want to use SSL to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: Verify Server Certificate: Select this option to verify the server certificate using a trust store. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. PostgreSQL Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). 3. Choose Test Connection to verify that you can successfully connect to your source database. 4. After you have finished adding the project information, and can successfully connect to your source database, choose Next. 5. On the page Step 2: Select Schema, choose the schema from your source database that you want to convert to your target RDS DB instance. 6. Choose Next to continue. The database migration assessment runs automatically after you choose Next. 7. On the page Step 3: Run the Database Migration Assessment, review the database migration assessment report, shown following. The database migration assessment report provides important information about the conversion of the schema from your source database to your target RDS DB instance. The report summarizes all of the schema conversion tasks and details actions to be taken for schema that cannot be converted to the DB engine of your target DB instance. The report also includes estimates of the amount of effort that it will take to write the equivalent code in your target DB instance for the schema that cannot be automatically converted. For more information on the database migration assessment report, see Creating and Using the Assessment Report (p. 47). 17

22 Step 1: Create an AWS Schema Conversion Tool Project 8. Choose Save to CSV or Save to PDF to save a local copy of the database migration assessment report as either a comma-separated values (CSV) file or a PDF file. This step is optional. You can view the database migration assessment report and save a local copy of it at any time after you create your project. 9. Choose Next to continue. The page Step 4: Select Target appears. 18

23 Step 1: Create an AWS Schema Conversion Tool Project 10. On the page Step 4: Select Target, add the information to connect to your target Amazon RDS DB instance. Use the instructions shown in the table following. For This Parameter Target DB Engine Server Name Server Port Username and Password Do This Choose the database engine for your target DB instance; Amazon Aurora, MySQL, or PostgreSQL. Type the DNS name of your target DB instance. Type the port used to connect to your target DB instance. Type the user name and password to connect to your target DB instance. te The AWS Schema Conversion Tool uses the password to connect to your target database only when you create your project or choose the Connect to target option in a project, where target is your target database. To guard against exposing the password for your target database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your target database as needed. 11. Choose Test Connection to verify that you can successfully connect to your target database. 12. Choose Finish to create your project. 19

24 Step 2: View the Schema from Your Source Database Step 2: View the Schema from Your Source Database Your AWS Schema Conversion Tool project displays the schema from your source database in the left panel. The schema is presented in a tree-view format, and each node of the tree is "lazy loaded." In other words, when you choose a node in the tree view, the AWS Schema Conversion Tool requests the schema information from your source database at that time. Step 3: Create the Schema Use the following procedure to create the converted schema. To create the converted schema 1. To see the main view of your project, choose View, and then Main View. 2. In the left panel that displays the schema from your source database, choose a schema object to convert. Open the context (right-click) menu for the object, and then choose Convert schema. 20

25 Step 3: Create the Schema When the AWS Schema Conversion Tool finishes converting the schema, you can view the proposed schema in the panel on the right of your project. At this point, no schema is applied to your target RDS DB instance. The planned schema is only part of your project. If you select a converted schema item, you can see the planned schema command in the panel at lower center for your target RDS DB instance. You can edit the schema in this window. The edited schema is stored as part of your project and is written to the target DB instance when you choose to apply your converted schema. 21

26 Step 4: Clear the Schema Step 4: Clear the Schema Before the AWS Schema Conversion Tool applies the schema to your target RDS DB instance, you can clear the planned schema from your project by opening the context (right-click) menu for the tree-view node for your target DB instance, and then choosing Refresh from Database. Because no schema has been written to your target DB instance, refreshing from the database removes the planned schema elements in your schema conversion tool project, to match what exists in your target DB instance. 22

27 Step 5: Update Your Source Schema Step 5: Update Your Source Schema You can update your AWS Schema Conversion Tool project with the most recent schema from your source database by opening the context (right-click) menu for the schema item from your source database that you want to update, and then choosing Refresh from Database. Doing this enables you to update your schema conversion tool project if changes have been made to the schema of your source database. 23

28 Step 6: Overwrite the Schema Step 6: Overwrite the Schema After you have refreshed the schema from your source database in your project, you can overwrite the converted schema in your project with updated schema. If you have made changes to the converted schema in your project, you lose those changes when you refresh the schema. To overwrite a converted schema in your project with an updated schema 1. In the left panel that displays the schema from your source database, choose the schema object to update the converted schema for. 2. Open the context (right-click) menu for the object, and then choose Convert Schema, as shown following. 24

29 Step 7: Create the Database Migration Assessment Report 3. In the Objects already exist in the target database. Replace? dialog box, choose to confirm that you want to overwrite the local schema. Step 7: Create the Database Migration Assessment Report The New Project wizard includes a step to create the database migration assessment report, which summarizes all of the action items for schema that cannot be converted to the engine of your target RDS DB instance.the report also includes estimates of the amount of effort that it will take to write the equivalent code in your target DB instance that cannot be automatically converted. You can create an updated database migration assessment report at any time in your project by using the following procedure. To create and view the database migration assessment report 1. In the left panel that displays the schema from your source database, choose a schema object to create an assessment report for. Open the context (right-click) menu for the object, and then choose Create Report, as shown following. 25

30 Step 7: Create the Database Migration Assessment Report The assessment report view then opens. 2. To explore the report, choose the Action Items tab. The Action Items tab displays a list of items that describe the schema that cannot automatically be converted to the database engine of your target RDS DB instance. 3. Select one of the action items from the list. tice that the AWS Schema Conversion Tool highlights the item from your schema that the action item applies to, as shown following. 26

31 Step 7: Create the Database Migration Assessment Report 4. To view the assessment report summary, choose the Summary tab. The Summary tab displays the summary information from the database migration assessment report. It shows the number of items that were automatically converted and the number of items that cannot be automatically converted. The summary also includes an estimate of the time that it will take to create schema in your target DB instance that are equivalent to those in your source database. An example is shown following. 27

32 Step 7: Create the Database Migration Assessment Report 5. To save the database migration assessment report as a PDF file and store it locally on your computer, choose the Summary tab, and then choose Save to PDF. The PDF file contains both the summary and action item information. You can also choose Save to CSV to save the report as a comma-separated values (CSV) file. The CSV file contains only action item information. 28

33 Step 8: Apply the Schema to the DB Instance Step 8: Apply the Schema to the DB Instance When you are ready, you can apply the converted database schema to your target RDS DB instance. After the schema has been applied to your target DB instance, you can update it based on the action items identified in the database migration assessment report. To apply the converted database schema to your target RDS DB instance Caution If you have an existing schema in your DB instance that matches the schema being applied, then the AWS Schema Conversion Tool overwrites the existing schema. This functionality is useful to update the schema in your target DB instance. However, be careful not to overwrite 29

34 Related Topics schema unintentionally especially a schema that you have modified in your target DB instance based on a database migration assessment report. 1. To apply the schema to your target DB instance, choose the schema element in the right panel of your project that displays the planned schema for your target DB instance. 2. Open the context (right-click) menu for the schema element, and then choose Apply to database. Related Topics What Is the AWS Schema Conversion Tool? (p. 1) Installing and Updating the AWS Schema Conversion Tool (p. 5) 30

35 Converting a Database Schema to Amazon RDS Using the AWS Schema Conversion Tool The AWS Schema Conversion Tool automates much of the process of converting your database schema to an Amazon Relational Database Service (Amazon RDS) MySQL DB instance, an Amazon Aurora DB cluster, or a PostgreSQL DB instance. The AWS Schema Conversion Tool supports the following conversions. Source Database Microsoft SQL Server MySQL Oracle PostgreSQL Target Database on Amazon RDS Amazon Aurora, MySQL, PostgreSQL PostgreSQL Amazon Aurora, MySQL, PostgreSQL Amazon Aurora, MySQL The source and target database engines contain many different features and capabilities, and the AWS Schema Conversion Tool attempts to create an equivalent schema in your RDS DB instance wherever possible. If no direct conversion is possible, the AWS Schema Conversion Tool provides a list of possible actions for you to take. The AWS Schema Conversion Tool creates a database migration assessment report that includes information on the schema elements that cannot be converted, along with guidance on how you can manually create equivalent schema from your source database in your target DB instance. 31

36 To convert your database schema to Amazon RDS, you take the high-level steps shown in the following table. Step Description Create your target DB instance. Create the Amazon RDS for MySQL DB instance, Amazon Aurora DB cluster, or PostgreSQL DB instance to host your converted schema and data. For a MySQL or PostgreSQL DB instance, be sure to allocate enough storage for your data once it is converted. Create a new AWS Schema Conversion Tool project, and connect to your source database. Connect your AWS Schema Conversion Tool project to your target DB instance. Create a database migration assessment report. The AWS Schema Conversion Tool creates a database migration assessment report that details the schema elements that cannot be converted automatically. You can use this report to identify where you need to create a schema in your RDS DB instance that is compatible with your source database. Relevant Documentation Creating an Amazon Aurora DB Cluster Creating a DB Instance Running the MySQL Database Engine Creating a DB Instance Running the PostgreSQL Database Engine Creating a Project with Microsoft SQL Server as the Source (p. 34) Creating a Project with MySQL as the Source (p. 37) Creating a Project with Oracle as the Source (p. 40) Creating a Project with PostgreSQL as the Source (p. 44) Connecting to an Amazon Aurora DB Cluster Connecting to a DB Instance Running the MySQL Database Engine Connecting to a DB Instance Running the PostgreSQL Database Engine Creating and Using the Assessment Report (p. 47) 32

37 Create a Project Step Description Convert your schema. The AWS Schema Conversion Tool creates a local version of the converted schema for you to review, but it doesn't apply it to your target DB instance until you are ready. Update and refresh the schema in your AWS Schema Conversion Tool project, if necessary. Apply the converted schema to Amazon RDS. When you are ready, have the AWS Schema Conversion Tool apply the converted schema in your local project to your RDS DB instance. Create any schema elements that cannot be automatically converted. If you have schema elements that cannot be automatically converted to your target database engine, create equivalent schema elements in your target RDS DB instance. Caution Once you manually add schema elements that cannot be automatically converted to your target DB instance, take care if you plan to rewrite the converted schema from the AWS Schema Conversion Tool to your target DB instance. Rewriting the converted schema overwrites the schema in your target DB instance, and any schema elements that you have manually added are lost. You might want to save your manual work before rewriting the converted schema, or you might want to avoid rewriting the converted schema and update the schema in your target DB instance using a different method. Relevant Documentation Converting Your Schema (p. 51) Updating and Refreshing Your Schema (p. 55) Applying Your Schema (p. 57) Creating an AWS Schema Conversion Tool Project The following procedures show you how to create a AWS Schema Conversion Tool project by choosing New Project from the File menu. You can also create a new AWS Schema Conversion Tool project by choosing New Project Wizard from the File menu, which starts the Create New Database Migration Project wizard. For an example of using the wizard, see Getting Started with the AWS Schema Conversion Tool (p. 10). Creating a Project with Microsoft SQL Server as the Source (p. 34) 33

38 Microsoft SQL Server as the Source Creating a Project with MySQL as the Source (p. 37) Creating a Project with Oracle as the Source (p. 40) Creating a Project with PostgreSQL as the Source (p. 44) Creating a Project with Microsoft SQL Server as the Source The following procedure creates a AWS Schema Conversion Tool project with Microsoft SQL Server as the source database. To create your project with Microsoft SQL Server as the source 1. Start the AWS Schema Conversion Tool, and choose New Project from the File menu. Add the following preliminary project information. For This Parameter Project Name Location Source DB Engine Target DB Engine Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose SQL Server. Choose the database engine for your target DB instance; Amazon Aurora, MySQL, or PostgreSQL. 2. Choose OK to create your AWS Schema Conversion Tool project. 3. Choose Connect to SQL Server. The Connect to SQL Server dialog box appears. 34

39 Microsoft SQL Server as the Source 4. Provide the Microsoft SQL Server source database connection information. Use the instructions in the following table. For This Parameter Project Name Location Source DB Engine Server name Server port Instance name Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose SQL Server. Type the Domain Name Service (DNS) name or IP address of your source database server. Type the port used to connect to your source database server. Type the instance name for the SQL Server database. To find the instance name, run the query on your SQL Server database. 35

40 Microsoft SQL Server as the Source For This Parameter User name and Password Use SSL Do This Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. Select this option if you want to use Secure Sockets Layer (SSL) to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: Trust Server Certificate: Select this option to trust the server certificate. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. Sql Server Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). 5. Choose Test Connection to verify that you can successfully connect to your source database. 6. Choose OK to connect to your source database. 7. Choose Connect to target, where target indicates the database engine for your target DB instance. 8. Add the following information to connect to your target RDS DB instance. For This Parameter Target DB Engine Server name Server port Do This Choose the database engine for your target DB instance; Amazon Aurora, MySQL, or PostgreSQL. Type the DNS name of your target DB instance. Type the port used to connect to your target DB instance. 36

41 MySQL as the Source For This Parameter User name and Password Do This Type the user name and password to connect to your target DB instance. te The AWS Schema Conversion Tool uses the password to connect to your target database only when you create your project or choose the Connect to target option in a project, where target is your target database. To guard against exposing the password for your target database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your target database as needed. 9. Choose OK to connect to your target DB instance. Creating a Project with MySQL as the Source The following procedure creates a AWS Schema Conversion Tool project with MySQL as the source database. To create your project with MySQL as the source 1. Start the AWS Schema Conversion Tool, and choose New Project from the File menu. Add the following preliminary project information. For This Parameter Project Name Location Source DB Engine Target DB Engine Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose MySQL. Choose the database engine for your target DB instance; Amazon Aurora or PostgreSQL. 2. Choose OK to create your AWS Schema Conversion Tool project. 3. Choose Connect to MySQL. The Connect to MySQL dialog box appears. 37

42 MySQL as the Source 4. Provide the MySQL source database connection information. Use the instructions in the following table. For This Parameter Project Name Location Source DB Engine Server name Server port Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose MySQL. Type the DNS name or IP address of your source database server. Type the port used to connect to your source database server. 38

43 MySQL as the Source For This Parameter User name and Password Use SSL Do This Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. Select this option if you want to use SSL to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: Require SSL: Select this option if you want to connect to the server only through SSL. te If you choose Require SSL, it means that if the server doesn't support SSL, you can't connect to the server. If you don't choose Require SSL and the server doesn't support SSL, you can still connect to the server without using SSL. For more information, see Using Secure Connections. Verify Server Certificate: Select this option to verify the server certificate using a trust store. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. MySql Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). 5. Choose Test Connection to verify that you can successfully connect to your source database. 6. Choose OK to connect to your source database. 7. Choose Connect to target, where target indicates the database engine for your target DB instance. 8. Add the following information to connect to your target RDS DB instance. For This Parameter Target DB Engine Server name Server port Do This Choose the database engine for your target DB instance; Amazon Aurora or PostgreSQL. Type the DNS name of your target DB instance. Type the port used to connect to your target DB instance. 39

44 Oracle as the Source For This Parameter User name and Password Do This Type the user name and password to connect to your target DB instance. te The AWS Schema Conversion Tool uses the password to connect to your target database only when you create your project or choose the Connect to target option in a project, where target is your target database. To guard against exposing the password for your target database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your target database as needed. 9. Choose OK to connect to your target DB instance. Creating a Project with Oracle as the Source The following procedure creates a AWS Schema Conversion Tool project with Oracle as the source database. To create your project with Oracle as the source 1. Start the AWS Schema Conversion Tool, and choose New Project from the File menu. Add the following preliminary project information. For This Parameter Project Name Location Source DB Engine Target DB Engine Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose Oracle. Choose the database engine for your target DB instance; Amazon Aurora, MySQL, or PostgreSQL. 2. Choose OK to create your AWS Schema Conversion Tool project. 3. Choose Connect to Oracle. The Connect to Oracle dialog box appears. 40

45 Oracle as the Source 4. Provide the Oracle source database connection information. Use the instructions in the following table. For This Parameter Project Name Location Source DB Engine Do This Type a name for your project, which is stored locally on your computer. Type the location for your local project file. Choose Oracle. 41

46 Oracle as the Source For This Parameter Type Do This Choose the connection type to your database. Depending on your type, provide the following additional information: SID Server name: The DNS name or IP address of your source database server. Server port: The port used to connect to your source database server. Oracle SID: The Oracle System ID (SID). To find the Oracle SID, submit the following query to your Oracle database: SELECT sys_context('userenv','instance_name') AS SID FROM dual; Service Name Server name: The DNS name or IP address of your source database server. Server port: The port used to connect to your source database server. Service Name: The name of the Oracle service to connect to. TNS Alias TNS file path: The path to the file that contains the Transparent Network Substrate (TNS) name connection information. TNS file path: The TNS alias from this file to use to connect to the source database. TNS Connect Identifier TNS identifier: The identifier for the registered TNS connection information. User name and Password Type the user name and password to connect to your source database server. te The AWS Schema Conversion Tool uses the password to connect to your source database only when you create your project or choose the Connect to source option in a project, where source is your source database. To guard against exposing the password for your source database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your source database as needed. 42

47 Oracle as the Source For This Parameter Use SSL Do This Select this option if you want to use SSL to connect to your database. Provide the following additional information, as appropriate, on the SSL tab: SSL Authentication: Select this option to use SSL authentication for the connection. Trust Store: The location of a trust store containing certificates. Trust Store Password: The password for the trust store. Key Store: The location of a key store containing a private key and certificates. This value is required if SSL Authentication is selected and is otherwise optional. Trust Store Password: The password for the key store. This value is required if SSL Authentication is selected and is otherwise optional. Oracle Driver Path Type the path to the driver to use to connect to the source database. For more information, see Required Database Drivers (p. 7). 5. Choose Test Connection to verify that you can successfully connect to your source database. 6. Choose OK to connect to your source database. 7. Choose Connect to target, where target indicates the database engine for your target DB instance. 8. Add the following information to connect to your target RDS DB instance. For This Parameter Target DB Engine Server name Server port User name and Password Do This Choose the database engine for your target DB instance; Amazon Aurora, MySQL, or PostgreSQL. Type the DNS name of your target DB instance. Type the port used to connect to your target DB instance. Type the user name and password to connect to your target DB instance. te The AWS Schema Conversion Tool uses the password to connect to your target database only when you create your project or choose the Connect to target option in a project, where target is your target database. To guard against exposing the password for your target database, the AWS Schema Conversion Tool doesn't store the password. If you close your AWS Schema Conversion Tool project and reopen it, you are prompted for the password to connect to your target database as needed. 9. Choose OK to connect to your target DB instance. 43