ApsaraDB for MongoDB:Restore the instance data by using the key-based flashback feature

Prerequisites

• A replica set or sharded cluster instance is created.

• The storage type of the instance is cloud disks.

• The major version of the instance is MongoDB 5.0 or later.

• The key-based flashback feature is in public preview. To use the feature, contact technical support.

Usage notes

The key-based flashback feature may compromise the instance performance. For example, the TPS performance of the instance may decrease by up to 3%.

Feature description

Billing rules

You are not charged for the use of the key-based flashback feature during public preview.

Enable the key-based flashback feature

1. Go to the Replica Set Instances or Sharded Cluster Instances page. In the top navigation bar, select the region in which the instance resides. Then, find the instance and click the ID of the instance.

2. In the left-side navigation pane of the instance details page, click Backup and Restoration.

3. Click the Flashback by Key tab.

4. Click Flashback Backup Settings.

   Note

   After you perform this operation, the You do not have the required permissions. message may appear. You must enter an account and a password. The account must have read/ write permissions on the database to be flashed back. For more information about database accounts and their permissions, see (Optional) Create a database account and grant permissions.

5. In the Flashback Backup Settings dialog box, configure parameters described in the following table and then click OK.

   Parameter	Description
   Retention Period for Backup files	The retention period of backup files. Valid values: 1 to 7. Unit: day. For example, if you set the parameter to 1, the system starts timing after flashback backup files are generated and automatically deletes the backup files one day later.
   Select Table to be Backed up	The collection to be backed up.
   Preview and Configure Indexes in Table to be Backed up	Indexes in the collection to be backed up. Default value: _id. Multiple indexes are separated by commas (,). You can specify a maximum of 10 indexes.

6. In the Modify Flashback Backup Settings dialog box, click OK.

Initiate a flashback task

1. On the Flashback by Key tab of the Backup and Restoration page, click Flash back Data by Time Point in the Actions column corresponding to the backup task that you want to manage.

2. In the panel that appears, configure the parameters described in the following table and then OK.

   Parameter	Description
   Select Table to be Restored	No modification is required.
   Create Temporary Table	The temporary collection that stores flashback data.
   Select Time Point for Restoration	The time point to which you want to flash data back.
   Enter Key to be Restored	Separate multiple primary keys with semicolons (;). For example, if the index is _id and the keys to be restored are key1 and key2, you must enter key1;key2 in the field. [ { "_id": "key1" }, { "_id": "key2" } ] is displayed in the Index Key Restoration Preview section. You can use the column=value syntax to specify a column for queries. For example, if you enter key1;test1=v1,key2 in the field, [ { "_id": "key1" }, { "test1": "v1", "_id": "key2" } ] is displayed in the Index Key Restoration Preview section. If a primary key contains commas (,) or semicolons (;), escape them with escape characters (\). For example, if the primary key is a,b, you must enter a\,b in the name field. Note If the value of this parameter is excessive characters in length, the system automatically splits the task that you want to initiate into multiple flashback subtasks. This does not affect the flashback backup.

3. In the Data Flashback Preview dialog box, select data that you want to flash back and then click OK.

After a flashback task is initiated, the flashback data is stored in a temporary collection. During the validity period of the temporary collection, you can restore the data in the temporary collection to the original collection. The validity period indicates the backup retention period specified when you enable the flashback backup feature.

Restore data to the original collection

1. On the Flashback by Key tab of the Backup and Restoration page, click the + icon on the left side of the backup task that you want to manage.

2. Click Restore to Original Table.

3. In the Restore to Original Table dialog box, click OK.

   Note

   • This operation restores data in a temporary collection to the original collection and overwrites data in the original collection.

   • The overwrite operation takes about 1 to 2 minutes. During this period, do not write the same key. Otherwise, the restored data may not meet your expectations.

You can click Flashback Records to view all flashback backup tasks and restore the data to be flashed back to the original collection. You can also click Restoration Task Records to view all flashback backup tasks.

Disable one or more flashback backup tasks