AWS SchemaConversionTool documentation change
Summary
Updated documentation structure, added detailed procedures for migration rules, schema conversion steps, manual conversion handling, and extension pack information. Changed terminology from 'Amazon RDS' to 'Amazon Redshift' in data warehouse context.
Security assessment
Changes focus on improving documentation structure, adding procedural details, and clarifying conversion processes. No references to security vulnerabilities, patches, or incident responses. The warning about not modifying extension pack schema is a general precaution, not a security fix.
Diff
diff --git a/SchemaConversionTool/latest/userguide/CHAP_Converting.md b/SchemaConversionTool/latest/userguide/CHAP_Converting.md index 0a6bfb05f..facb728f2 100644 --- a/SchemaConversionTool/latest/userguide/CHAP_Converting.md +++ b/SchemaConversionTool/latest/userguide/CHAP_Converting.md @@ -5 +5,3 @@ -# Converting database schemas in AWS Schema Conversion Tool +Creating migration rulesConverting your schemaHandling manual conversionsUpdating and refreshing your converted schemaSaving and applying your schema + +# Converting database schemas using AWS SCT @@ -22 +24 @@ For example, you can use AWS SCT to do the following: - * [Applying migration rules in AWS Schema Conversion Tool](./CHAP_Converting.MigrationRules.html) + * Creating migration rules in AWS SCT @@ -24 +26 @@ For example, you can use AWS SCT to do the following: - * [Converting schemas usinf AWS SCT](./CHAP_Converting.Convert.html) + * Converting your schema by using AWS SCT @@ -26 +28 @@ For example, you can use AWS SCT to do the following: - * [Manually converting schemas in AWS SCT](./CHAP_Converting.Manual.html) + * Handling manual conversions in AWS SCT @@ -28 +30 @@ For example, you can use AWS SCT to do the following: - * [Updating and refreshing converted schemas in AWS SCT](./CHAP_Converting.UpdateRefresh.html) + * Updating and refreshing your converted schema in AWS SCT @@ -30 +32 @@ For example, you can use AWS SCT to do the following: - * [Saving and applying converted schemas in AWS SCT](./CHAP_Converting.SaveAndApply.html) + * Saving and applying your converted schema in AWS SCT @@ -32 +34 @@ For example, you can use AWS SCT to do the following: - * [Comparing schemas in AWS Schema Conversion Tool](./CHAP_Converting.SchemaCompare.html) + * [Comparing database schemas](./CHAP_Converting.SchemaCompare.html) @@ -34 +36 @@ For example, you can use AWS SCT to do the following: - * [Viewing related transformed objects in AWS Schema Conversion Tool](./CHAP_Converting.RelatedObjects.html) + * [Finding related transformed objects](./CHAP_Converting.RelatedObjects.html) @@ -52 +54 @@ SAP ASE (12.5, 15.0, 15.5, 15.7, and 16.0) | Aurora MySQL, Aurora PostgreSQL, M -For information about converting a data warehouse schema, see [Converting data warehouse schemas to Amazon RDS using AWS SCT](./CHAP_Converting.DW.html). +For information about converting a data warehouse schema, see [Converting data warehouse schemas to Amazon Redshift using AWS SCT](./CHAP_Converting.DW.html). @@ -56 +58,269 @@ To convert your database schema to Amazon RDS, you take the following high-level - * [Creating migration rules in AWS SCT](./CHAP_Converting.MigrationRules.html) – Before you convert your schema with AWS SCT, you can set up rules that change the data type of columns, move objects from one schema to another, and change the names of objects. + * Creating migration rules in AWS SCT – Before you convert your schema with AWS SCT, you can set up rules that change the data type of columns, move objects from one schema to another, and change the names of objects. + + * Converting your schema by using AWS SCT – AWS SCT 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. + + * [Creating migration assessment reports with AWS SCT](./CHAP_AssessmentReport.html) – AWS SCT creates a database migration assessment report that details the schema elements that can't be converted automatically. You can use this report to identify where you need to create a schema in your Amazon RDS DB instance that is compatible with your source database. + + * Handling manual conversions in AWS SCT – If you have schema elements that can't be converted automatically, you have two choices: update the source schema and then convert again, or create equivalent schema elements in your target Amazon RDS DB instance. + + * Updating and refreshing your converted schema in AWS SCT – You can update your AWS SCT project with the most recent schema from your source database. + + * Saving and applying your converted schema in AWS SCT – When you are ready, have AWS SCT apply the converted schema in your local project to your target Amazon RDS DB instance. + + + + +## Creating migration rules in AWS SCT + +Before you convert your schema with AWS SCT, you can set up migration rules. _Migration rules_ in AWS SCT can do such transformations as change the data type of columns, move objects from one schema to another, and change the names of objects. For example, suppose that you have a set of tables in your source schema named `test_TABLE_NAME`. You can set up a rule that changes the prefix `test_` to the prefix `demo_` in the target schema. + +###### Note + +You can only create migration rules for different source and target database engines. + +You can create migration rules that perform the following tasks: + + * Add, remove, or replace a prefix + + * Add, remove, or replace a suffix + + * Change column collation + + * Change data type + + * Change the length of `char`, `varchar`, `nvarchar`, and `string` data types + + * Move objects + + * Rename objects + + + + +You can create migration rules for the following objects: + + * Database + + * Schema + + * Table + + * Column + + + + +### Creating migration rules + +You can create migration rules and save the rules as part of your project. With your project open, use the following procedure to create migration rules. + +###### To create migration rules + + 1. On the **View** menu, choose **Mapping view**. + + 2. In **Server mappings** , choose a pair of source and target servers. + + 3. Choose **New migration rule**. The **Transformation rules** dialog box appears. + + 4. Choose **Add new rule**. A new row is added to the list of rules. + + 5. Configure your rule: + + 1. For **Name** , enter a name for your rule. + + 2. For **For** , choose the type of object that the rule applies to. + + 3. For **where** , enter a filter to apply to objects before applying the migration rule. The where clause is evaluated by using a like clause. You can enter an exact name to select one object, or you can enter a pattern to select multiple objects. + +The fields available for the **where** clause are different depending on the type of the object. For example, if the object type is schema there is only one field available, for the schema name. + + 4. For **Actions** , choose the type of migration rule that you want to create. + + 5. Depending on the rule type, enter one or two additional values. For example, to rename an object, enter the new name of the object. To replace a prefix, enter the old prefix and the new prefix. + +For char, varchar, nvarchar, and string data types, you can change the data type length using the multiplication operator. For example, the `%*4` value transforms the `varchar(10)` data type into `varchar(40)`. + + 6. After you have configured your migration rule, choose **Save** to save your rule. You can also choose **Cancel** to cancel your changes. + + + + 7. After you are done adding, editing, and deleting rules, choose **Save All** to save all your changes. + + 8. Choose **Close** to close the **Transformation rules** dialog box. + + + + +You can use the toggle icon to turn off a migration rule without deleting it. You can use the copy icon to duplicate an existing migration rule. You can use the pencil icon to edit an existing migration rule. You can use the delete icon to delete an existing migration rule. To save any changes you make to your migration rules, choose **Save All**. + +### Exporting migration rules + +If you use AWS DMS to migrate your data from your source database to your target database, you can provide information about your migration rules to AWS DMS. For more information about tasks, see [Working with AWS Database Migration Service replication tasks](https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html). + +###### To export migration rules + + 1. In the AWS Schema Conversion Tool, choose **Mapping View** on the **View** menu. + + 2. In **Migration rules** , choose a migration rule and then choose **Modify migration rule**. + + 3. Choose **Export script for AWS DMS**. + + 4. Browse to the location where you want to save your script, and then choose **Save**. Your migration rules are saved as a JSON script that can be consumed by AWS DMS. + + + + +## Converting your schema by using AWS SCT + +After you have connected your project to both your source database and your target Amazon RDS DB instance, 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. When you choose a node in the tree view, AWS SCT requests the schema information from your source database at that time. + +You can choose schema items from your source database and then convert the schema to equivalent schema for the DB engine of your target DB instance. You can choose any schema item from your source database to convert. If the schema item that you choose depends on a parent item, then AWS SCT also generates the schema for the parent item. For example, suppose that you choose a table to convert. If so, AWS SCT generates the schema for the table, and the database that the table is in. + +### Converting schema + +To convert a schema from your source database, select the check box for the name of schema to convert. Next, choose this schema from the left panel of your project. AWS SCT highlights the schema name in blue. Open the context (right-click) menu for the schema, and choose **Convert schema** , as shown following. + + + +After you have converted the schema from your source database, you can choose schema items from the left panel of your project and view the converted schema in the center panels of your project. The lower-center panel displays the properties of and the SQL command to create the converted schema, as shown following. + + + +After you have converted your schema, you can save your project. The schema information from your source database is saved with your project. This functionality means that you can work offline without being connected to your source database. AWS SCT connects to your source database to update the schema in your project if you choose **Refresh from Database** for your source database. For more information, see Updating and refreshing your converted schema in AWS SCT. + +You can create a database migration assessment report of the items that can't be converted automatically. The assessment report is useful for identifying and resolving schema items that can't be converted automatically. For more information, see [Creating migration assessment reports with AWS SCT](./CHAP_AssessmentReport.html). + +When AWS SCT generates a converted schema, it doesn't immediately apply it to the target DB instance. Instead, the converted schema is stored locally until you are ready to apply it to the target DB instance. For more information, see Applying your converted schema. + +### Editing converted schema + +You can edit converted schema and save the changes as part of your project. + +###### To edit converted schema + + 1. In the left panel that displays the schema from your source database, choose the schema item that you want to edit the converted schema for. + + 2. In the lower-center panel that displays the converted schema for the selected item, choose the **SQL** tab. + + 3. In the text displayed for the **SQL** tab, change the schema as needed. The schema is automatically saved with your project as you update it. + + + + + + +The changes that you make to converted schema are stored with your project as you make updates. If you newly convert a schema item from your source database, and you have made updates to previously converted schema for that item, those existing updates are replaced by the newly converted schema item based on your source database. + +### Clearing a converted schema + +Until you apply the schema to your target DB instance, AWS SCT only stores the converted schema locally in your project. You can clear the planned schema from your project by choosing the tree-view node for your 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 AWS SCT project to match what exists in your source DB instance. + +## Handling manual conversions in AWS SCT + +The assessment report includes a list of items that can't be converted automatically to the database engine of your target Amazon RDS DB instance. For each item that can't be converted, there is an action item on the **Action Items** tab. + +You can respond to the action items in the assessment report in the following ways: