AWS AmazonRDS documentation change
Summary
Updated documentation for data import procedure with clearer step descriptions, added CLI command references, and rephrased explanations about backups and snapshots.
Security assessment
The changes primarily improve clarity and procedural details without addressing specific security vulnerabilities. While backup-related steps (turning off automated backups) have security implications, the modifications only clarify existing documentation rather than introducing new security features or addressing disclosed vulnerabilities.
Diff
diff --git a/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.AnySourceMariaDB.md b/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.AnySourceMariaDB.md index b5878cfc2..9bf15f665 100644 --- a//AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.AnySourceMariaDB.md +++ b//AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.AnySourceMariaDB.md @@ -5 +5 @@ -Step 1: Create flat files containing the data to be loadedStep 2: Stop any applications accessing the target DB instanceStep 3: Create a DB snapshotStep 4: Consider turning off Amazon RDS automated backupsStep 5: Load the dataStep 6: Turn Amazon RDS automated backups back on +Step 1: Create flat filesStep 2: Stop any applicationsStep 3: Create a DB snapshotStep 4 (Optional): Turn off automated backupsStep 5: Load the dataStep 6: Turn back on automated backups @@ -9,20 +9 @@ Step 1: Create flat files containing the data to be loadedStep 2: Stop any appli -We recommend creating DB snapshots of the target Amazon RDS DB instance before and after the data load. Amazon RDS DB snapshots are complete backups of your DB instance that can be used to restore your DB instance to a known state. When you initiate a DB snapshot, I/O operations to your DB instance are momentarily suspended while your database is backed up. - -Creating a DB snapshot immediately before the load makes it possible for you to restore the database to its state before the load, if you need to. A DB snapshot taken immediately after the load protects you from having to load the data again in case of a mishap and can also be used to seed new database instances. - -The following list shows the steps to take. Each step is discussed in more detail following. - - 1. Create flat files containing the data to be loaded. - - 2. Stop any applications accessing the target DB instance. - - 3. Create a DB snapshot. - - 4. Consider turning off Amazon RDS automated backups. - - 5. Load the data. - - 6. Enable automated backups again. - - - +The following steps walk you through importing data to an Amazon RDS DB instance: @@ -32 +13 @@ The following list shows the steps to take. Each step is discussed in more detai -Use a common format, such as comma-separated values (CSV), to store the data to be loaded. Each table must have its own file; you can't combine data for multiple tables in the same file. Give each file the same name as the table it corresponds to. The file extension can be anything you like. For example, if the table name is `sales`, the file name might be `sales.csv` or `sales.txt`, but not `sales_01.csv`. +Use a common format, such as comma-separated values (CSV), to store the data to be loaded. Each table must have its own file—you can't combine data for multiple tables in the same file. Give each file the same name as the table it corresponds to. The file extension can be anything you like. For example, if the table name is `sales`, the file name could be `sales.csv` or `sales.txt`. @@ -34 +15 @@ Use a common format, such as comma-separated values (CSV), to store the data to -Whenever possible, order the data by the primary key of the table being loaded. Doing this drastically improves load times and minimizes disk storage requirements. +If possible, order the data by the primary key of the table being loaded. Doing this drastically improves load times and minimizes disk storage requirements. @@ -38 +19 @@ The speed and efficiency of this procedure depends on keeping the size of the fi -On Unix-like systems (including Linux), use the `split` command. For example, the following command splits the `sales.csv` file into multiple files of less than 1 GiB, splitting only at line breaks (-C 1024m). The new files are named `sales.part_00`, `sales.part_01`, and so on. +On Unix-like systems (including Linux), use the `split` command. For example, the following command splits the `sales.csv` file into multiple files of less than 1 GiB, splitting only at line breaks (-C 1024m). The names of the new files include ascending numerical suffixes. The following command produces files with names such as `sales.part_00` and `sales.part_01`. @@ -45 +26 @@ Similar utilities are available for other operating systems. -You can store the flat files anywhere. However, when you load the data, you must invoke the `mysql` shell from the same location where the files exist, or use the absolute path for the files when you run `LOAD DATA LOCAL INFILE`. +You can store the flat files anywhere. However, when you load the data in Step 5, you must invoke the `mysql` shell from the same location where the files exist, or use the absolute path for the files when you run `LOAD DATA LOCAL INFILE`. @@ -47 +28 @@ You can store the flat files anywhere. However, when you load the data, you must -## Step 2: Stop any applications accessing the target DB instance +## Step 2: Stop any applications from accessing the target DB instance @@ -49 +30 @@ You can store the flat files anywhere. However, when you load the data, you must -Before starting a large load, stop all application activity accessing the target DB instance that you plan to load to. We recommend this particularly if other sessions will be modifying the tables being loaded or tables that they reference. Doing this reduces the risk of constraint violations occurring during the load and improves load performance. It also makes it possible to restore the DB instance to the point just before the load without losing changes made by processes not involved in the load. +Before starting a large load, stop all application activity from accessing the target DB instance that you plan to load to. We recommend this particularly if other sessions will be modifying the tables being loaded or tables that they reference. Doing this reduces the risk of constraint violations occurring during the load and improves load performance. It also makes it possible to restore the DB instance to the point just before the load without losing changes made by processes not involved in the load. @@ -55 +36 @@ Of course, this might not be possible or practical. If you can't stop applicatio -If you plan to load data into a new DB instance that contains no data, you can skip this step. Otherwise, creating a DB snapshot of your DB instance makes it possible for you to restore the DB instance to the point just before the load, if it becomes necessary. As previously mentioned, when you initiate a DB snapshot, I/O operations to your DB instance are suspended for a few minutes while the database is backed up. +If you plan to load data into a new DB instance that contains no data, you can skip this step. Otherwise, we recommend that you create DB snapshots of the target Amazon RDS DB instance both before and after the data load. Amazon RDS DB snapshots are complete backups of your DB instance that you can use to restore your DB instance to a known state. When you initiate a DB snapshot, I/O operations to your DB instance are momentarily suspended while your database is backed up. @@ -57 +38,3 @@ If you plan to load data into a new DB instance that contains no data, you can s -The following example runs the AWS CLI `create-db-snapshot` command to create a DB snapshot of the `AcmeRDS` instance and give the DB snapshot the identifier `"preload"`. +Creating a DB snapshot immediately before the load makes it possible for you to restore the database to its state before the load, if you need to. A DB snapshot taken immediately after the load protects you from having to load the data again in case of a mishap. You can also use DB snapshots after the load to import data into new database instances. + +The following example runs the AWS CLI [create-db-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/create-db-snapshot.html) command to create a DB snapshot of the `AcmeRDS` instance and give the DB snapshot the identifier `"preload"`. @@ -77 +60 @@ Keep in mind that restoring a database from a DB snapshot creates a new DB insta -For example, to create a DB instance for dry runs or other testing, you give the DB instance its own identifier. In the example, `AcmeRDS-2`" is the identifier. The example connects to the DB instance using the endpoint associated with `AcmeRDS-2`. +For example, to create a DB instance for dry runs or other testing, you give the DB instance its own identifier. In the example, `AcmeRDS-2`" is the identifier. The example connects to the DB instance using the endpoint associated with `AcmeRDS-2`. For more information, see [restore-db-instance-from-db-snapshot](https://docs.aws.amazon.com/cli/latest/reference/rds/restore-db-instance-from-db-snapshot.html). @@ -93 +76,3 @@ For Windows: -To reuse the existing endpoint, first delete the DB instance and then give the restored database the same identifier. +To reuse the existing endpoint, first delete the DB instance and then give the restored database the same identifier. For more information, see [delete-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/delete-db-instance.html). + +The following example also takes a final DB snapshot of the DB instance before deleting it. This is optional but recommended. @@ -117,3 +102 @@ For Windows: -The preceding example takes a final DB snapshot of the DB instance before deleting it. This is optional but recommended. - -## Step 4: Consider turning off Amazon RDS automated backups +## Step 4 (Optional): Turn off Amazon RDS automated backups @@ -123 +106 @@ The preceding example takes a final DB snapshot of the DB instance before deleti -Do not turn off automated backups if you need to perform point-in-time recovery. +Don't turn off automated backups if you need to perform point-in-time recovery. @@ -125 +108 @@ Do not turn off automated backups if you need to perform point-in-time recovery. -Turning off automated backups erases all existing backups, so point-in-time recovery isn't possible after automated backups have been turned off. Disabling automated backups is a performance optimization and isn't required for data loads. Manual DB snapshots aren't affected by turning off automated backups. All existing manual DB snapshots are still available for restore. +Turning off automated backups is a performance optimization and isn't required for data loads. Turning off automated backups erases all existing backups. As a result, after you turn off automated backups, point-in-time recovery isn't possible. Manual DB snapshots aren't affected by turning off automated backups. All existing manual DB snapshots are still available for restore. @@ -129 +112 @@ Turning off automated backups reduces load time by about 25 percent and reduces -DB instances have automated backups turned on by default (with a one day retention period). To turn off automated backups, set the backup retention period to zero. After the load, you can turn backups back on by setting the backup retention period to a nonzero value. To turn on or turn off backups, Amazon RDS shuts the DB instance down and restarts it to turn MariaDB or MySQL logging on or off. +DB instances have automated backups turned on by default (with a one day retention period). To turn off automated backups, set the backup retention period to zero. After the load, you can turn backups back on by setting the backup retention period to a nonzero value. To turn on or turn off backups, Amazon RDS shuts the DB instance down and then restarts it to turn MariaDB or MySQL logging on or off. @@ -131 +114 @@ DB instances have automated backups turned on by default (with a one day retenti -Run the AWS CLI `modify-db-instance` command to set the backup retention to zero and apply the change immediately. Setting the retention period to zero requires a DB instance restart, so wait until the restart has completed before proceeding. +Run the AWS CLI `modify-db-instance` command to set the backup retention to zero and apply the change immediately. Setting the retention period to zero requires a DB instance restart, so wait until the restart has completed before proceeding. For more information, see [modify-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html). @@ -149 +132 @@ For Windows: -You can check the status of your DB instance with the AWS CLI `describe-db-instances` command. The following example displays the DB instance status of the `AcmeRDS` DB instance. +You can check the status of your DB instance with the AWS CLI [describe-db-instances](https://docs.aws.amazon.com/cli/latest/reference/rds/describe-db-instances.html) command. The following example displays the DB instance status of the `AcmeRDS` DB instance: @@ -154 +137 @@ You can check the status of your DB instance with the AWS CLI `describe-db-insta -When the DB instance status is `available`, you're ready to proceed. +When the DB instance status is `available`, you're ready to proceed to the next step. @@ -158 +141 @@ When the DB instance status is `available`, you're ready to proceed. -Use the MySQL `LOAD DATA LOCAL INFILE` statement to read rows from your flat files into the database tables. +To read rows from your flat files into the database tables, use the MySQL `LOAD DATA LOCAL INFILE` statement. @@ -164 +147 @@ You must invoke the `mysql` shell from the same location where your flat files e -The following example shows you how to load data from a file named `sales.txt` into a table named `Sales` in the database. +The following example shows how to load data from a file named `sales.txt` into a table named `Sales` in the database: @@ -171 +154 @@ The following example shows you how to load data from a file named `sales.txt` i -For more information about the `LOAD DATA` statement, see [the MySQL documentation](https://dev.mysql.com/doc/refman/8.0/en/load-data.html). +For more information about the `LOAD DATA` statement, see [LOAD DATA Statement](https://dev.mysql.com/doc/refman/8.4/en/load-data.html) in the MySQL documentation. @@ -173 +156 @@ For more information about the `LOAD DATA` statement, see [the MySQL documentati -## Step 6: Turn Amazon RDS automated backups back on +## Step 6: Turn back on Amazon RDS automated backups @@ -175 +158 @@ For more information about the `LOAD DATA` statement, see [the MySQL documentati -After the load is finished, turn Amazon RDS automated backups on by setting the backup retention period back to its preload value. As noted earlier, Amazon RDS restarts the DB instance, so be prepared for a brief outage. +If you turned off Amazon RDS automated backups in Step 4, after the load is finished, turn automated backups on by setting the backup retention period back to its preload value. As noted in Step 4, Amazon RDS restarts the DB instance, so be prepared for a brief outage. @@ -177 +160 @@ After the load is finished, turn Amazon RDS automated backups on by setting the -The following example runs the AWS CLI `modify-db-instance` command to turn on automated backups for the `AcmeRDS` DB instance and set the retention period to one day. +The following example runs the AWS CLI [modify-db-instance](https://docs.aws.amazon.com/cli/latest/reference/rds/modify-db-instance.html) command to turn on automated backups for the `AcmeRDS` DB instance and set the retention period to one day: