Managing a Backup

Editing a Backup

Use the Console or the command-line interface to edit the display name, description, retention period, and soft delete of a DB system backup.

Note

You cannot change the retention period of automatic backups.

The retention period of final backups of Always Free DB systems is limited to a maximum of 7 days.

You cannot change the soft delete of backups of Always Free DB systems.

Use the Console or the command-line interface to edit a backup:

Using the Console
Using the CLI
Using the REST API, run the UpdateBackup operation.

Using the Console

Use the Console to edit the display name, description, and retention period of your backup.

Note

The Edit backup panel is different from the Edit backup plan panel. The Edit backup plan panel enables you to enable automatic backups, edit the retention period and window start time of an existing DB system. See Editing a Backup Plan.

Open the navigation menu and select Databases. Under HeatWave MySQL, select Backups.
Do one of the following:
- Select Edit from the Actions menu on the same line as your DB system.
- Select the name of the backup to open the Backup details page and select Edit.
On the Edit backup panel, provide the following details:
- Display name: Specify the new name of the backup. If you do not modify the name, the existing name is retained.
- Description: Specify the new description of the backup. If you do not modify the description, the existing description is retained.
- Retention period: Specify the new retention period of the backup. If you do not modify the retention period, the existing value is retained.
  Note
  
  You cannot change the retention period of automatic backups.
- Soft delete: Specify the new soft delete setting. If you do not modify it, the existing setting is retained.
  Note
  
  When enabled, it retains the backup to be deleted by due to the retention policy in DELETE_SCHEDULED state for 7 additional days before permanently deleting it.
Select Save changes.

The backup metadata is updated.

Using the CLI

Use the command-line interface to update the display name, description, retention period, and soft delete of your backup.

This task requires the following:

A backup OCID.
A policy that permits you to update backups in the compartment or tenancy.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Do the following on the CLI to update a backup:

Open a command prompt, and run the following command:
```
oci mysql backup update 
--backup-id <BackupOCID> 
--display-name <DisplayName>
--description <Description>
--retention-in-days <NumberOfDays>
--soft-delete ENABLED
```
- --backup-id: Specify the OCID of the backup.
- --display-name: (Optional) Specify the new display name of the backup. If you do not define a display name, the existing name is retained.
- --description: (Optional) Specify the new description of the backup. If you do not define a description, the existing description is retained.
- --retention-in-days: (Optional) Specify the new number of days to retain the backup. If you do not define a number, the existing retention period is retained.
- --soft-delete: (Optional) Specify the soft delete setting of the backup, ENABLED or DISABLED.

HeatWave Service updates the backup metadata.

Editing a Backup Plan

Edit the backup plan of an existing DB system to enable automatic backups, point in time recovery, and soft delete, edit the retention period and window start time, and schedule cross-region backup copy.

Note

You cannot change the backup plan of an Always Free DB system.

Using the Console
Using the REST API, run the UpdateDbSystem operation with the backupPolicy attribute.

Using the Console

Use the Console to edit the backup plan of an existing DB system.

Note

The Edit backup plan panel is different from the Edit backup panel. The Edit backup panel enables you to edit the display name and description of the backup. See Editing a Backup.

Navigate to the DB system details page of the DB system.
From the More actions menu, select Edit backup plan.
On the Edit backup plan panel:
Enable automatic backups: Select to enable automatic backups, and to configure the backup retention period, enable point-in-time recovery, and select the backup window. If you do not enable automatic backups, create a manual backup. It is recommended to enable automatic backups.
- Backup plan:
  - Backup retention period: (Optional) Specify how long to retain the backups, in days. The default retention period is seven days.
  - Enable point-in-time recovery: Select the option to enable you to restore a DB system at a point-in-time to a new DB system.
  - Select backup window: Select to enable you to define the starting time of backup of your DB system in the Window start time field. Your backup starts at some point in the 30 minutes following the Window start time. Select Show backup windows per region to view the default backup window specific to your region.
    Note
    
    Do not set the backup window start time too near to the maintenance window start time. The automatic backup cannot start if a conflicting operation such as maintenance or upgrade is currently running. It has to wait until the conflicting operation completes. If the conflicting operation does not complete within two hours of the backup window start time, the automatic backup will be skipped and it will try again in the next backup window in the following day.
  - Soft delete: Select to enable soft delete.
  Note
  
  There is no impact on the DB system or the database connections when the automatic backup is created.
- Cross-region copy: Select the option to schedule cross-region copy. If enabled, each automatic backup is copied to selected destination region.
  - Destination region: Select a destination region to which the backup is copied.
  - Backup retention period: (Optional) Specify how many days you want to retain the backup in the destination region. If not defined, the default value is the same as the retention period of the source backup.
  Note
  
  You must have the MYSQL_BACKUP_COPY permission in order to enable cross-region copy. The MYSQL_BACKUP_COPY permission is not included in the mysql-family aggregate resource type. The tenancy must also subscribe to the destination region.
Select Save changes.

The backup plan is updated.

Moving a Backup

You can move an active backup to a different compartment. You can not move a backup that is in any other state.

Note

You cannot move backups of an Always Free DB system to another compartment.

Use the Console or the command-line interface to move a backup to a different compartment.

Using the Console
Using the CLI
Using the REST API, run the ChangeBackupCompartment operation.

Using the Console

Use the Console to move your backup to a different compartment.

This task requires the following:

The access permission, MYSQL_BACKUP_MOVE, on the compartment to which you want to move your backup. See mysql-backups.
An active backup. You can not move a backup that is in any other state.

Do the following to move a backup to a different compartment:

Open the navigation menu, and select Databases. Under HeatWave MySQL, select Backups.
Choose your compartment from the List scope.
Do one of the following:
- Choose Move resource from the Actions menu on the same line as your backup.
- Select the name of the backup to open the Backup details page. Select Move resource.
In the Move resource dialog box, choose the new compartment. You cannot select the compartment the backup is currently in.
Select Move backup.

The backup is moved to the selected compartment.

Using the CLI

Use the command-line interface to move a backup to a different compartment.

This task requires the following:

A backup OCID.
A policy that permits you to move backups in the compartment or tenancy.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Do the following on the CLI to move a backup to a different compartment:

Open a command prompt, and run the following command:
```
oci mysql backup change-compartment 
--backup-id <BackupOCID> 
--compartment-id <TargetCompartmentOCID>
```
- --backup-id: Specify the OCID of the backup.
- --compartment-id: Specify the OCID of the target compartment to which the backup is moved.

HeatWave Service moves the backup to the target compartment.

Deleting a Backup

Use the Console or the command-line interface to delete a backup of the DB system.

Using the Console
Using the CLI
Using the REST API, run the DeleteBackup operation.

Using the Console

Use the Console to delete a backup of your DB system.

Open the navigation menu and select Databases. Under HeatWave MySQL, click Backups.
Do one of the following:
- Choose Delete from the Actions menu on the same line as your backup.
- Click the name of the backup to open the Backup details page. Click the More actions button and select Delete.
On the Delete backup dialog box, select Delete backup.

The backup is deleted.

Using the CLI

Use the command-line interface to delete a backup.

This task requires the following:

A backup OCID.
A policy that permits you to delete backups in the compartment or tenancy.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Do the following on the CLI to delete a backup:

Open a command prompt, and run the following command:
```
oci mysql backup delete --backup-id <BackupOCID> 
```
- --backup-id: Specify the OCID of the backup.

HeatWave Service deletes the backup.

Canceling the Deletion of a Backup

Use the Console or the command-line interface to cancel the deletion of a backup.

Using the Console

Use the Console to cancel the scheduled deletion of a backup.

Open the navigation menu and select Databases. Under HeatWave MySQL, select Backups.
Do one of the following:
- Choose Cancel deletion from the Actions menu on the same line as your backup.
- Select the name of the backup to open the Backup details page. Select the More actions button and select Cancel deletion.
On the Cancel deletion dialog box, select Cancel deletion.

The scheduled deletion of the backup is canceled.

Using the CLI

Use the command-line interface to cancel the deletion of a backup.

This task requires the following:

The OCID of a backup that has the DELETE SCHEDULED state.
A policy that permits you to cancel the delete of backups in the compartment or tenancy.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.

Do the following on the CLI to delete a backup:

Open a command prompt, and run the following command:
```
oci mysql backup cancel-backup-deletion --backup-id <BackupOCID> 
```
- --backup-id: Specify the OCID of the backup.

HeatWave Service cancels scheduled deletion of the backup.

Copying a Backup to Another Region

Copy a backup of the DB system to another region.

Note

You cannot copy backups of an Always Free DB system to another region.

After copying the backup of a DB system to another region, you can restore the DB system in the destination region. It does not copy the configuration of the DB system on which the backup was taken.

When copying DB system backups across regions in your tenancy, the MySQL Maximum Parallel Cross-Region Backup Copy Count service limit determines the maximum number of concurrent copies that you can perform from a specific source region.

This task requires the following:

An active backup in any region:
Note

You can copy the backup to another region within the same realm in Oracle Cloud Infrastructure. The backup is not currently being copied to the same destination region. You cannot create a copy of the backup in the same region.
The access permission, MYSQL_BACKUP_COPY and MYSQL_BACKUP_READ, in the source region where the backup is located in. See mysql-backups.
Note

The aggregate resource type mysql-family does not include the MYSQL_BACKUP_COPY permission.
The access permission, MYSQL_BACKUP_CREATE, in the destination region where the backup is to be copied to. See mysql-backups.

Sample Policies

To allow a group named MyTestGroup1 to copy DB system backups between any regions:

Allow group MyTestGroup1 to read mysql-backups in tenancy
Allow group MyTestGroup1 to use mysql-backups in tenancy where request.permission = 'MYSQL_BACKUP_COPY'
Allow group MyTestGroup1 to manage mysql-backups in tenancy where request.permission = 'MYSQL_BACKUP_CREATE'

To allow a group named MyTestGroup2 to copy DB system backups from the US West (Phoenix) and US East (Ashburn) regions to any destination regions:

Allow group MyTestGroup2 to read mysql-backups in tenancy
Allow group MyTestGroup2 to use mysql-backups in tenancy where all {request.permission = 'MYSQL_BACKUP_COPY', any {request.region='phx', request.region='iad'})
Allow group MyTestGroup2 to manage mysql-backups in tenancy where request.permission = 'MYSQL_BACKUP_CREATE'

To allow a group named MyTestGroup3 to copy DB system backups from the UK South (London) region to the Germany Central (Frankfurt) region:

Allow group MyTestGroup3 to read mysql-backups in tenancy where request.region = 'lhr'
Allow group MyTestGroup3 to use mysql-backups in tenancy where all {request.permission = 'MYSQL_BACKUP_COPY', request.region = 'lhr', target.destination-region = 'fra'}
Allow group MyTestGroup3 to manage mysql-backups in tenancy where all {request.permission = 'MYSQL_BACKUP_CREATE', request.region = 'fra'}

Use the Console or the command-line interface to copy a backup of the DB system to another region .

Using the Console
Using the CLI
Using the REST API, run the CopyBackup operation.

Using the Console

Use the Console to copy your backup to another region.

Do the following to copy a backup to another region:

Open the navigation menu and select Databases. Under HeatWave MySQL, select Backups.
Do one of the following:
- Select Copy to another region from the Actions menu on the same line as your backup.
- Select the name of the backup to open the Backup details page and select Copy to another region.
On the Copy to another region panel, provide the following details:
1. Destination region: Select the region to which the backup is copied.
2. Destination region compartment: The compartment cannot be changed. It always copy to the same compartment.
3. Display name: (Optional) Specify the name of the backup. The default value is "<SourceBackupName>-copy-from-<SourceRegionName>".
4. Description: (Optional) Specify the description of the backup. The default value is "This backup is a copy of <SoureBackupName> from the region <SourceRegionName>."
5. Backup retention period: (Optional) Specify the retention period of the backup in the destination region. The default is the retention period of the source backup.
  
  Note
  
  The maximum retention period of an automatic backup is 35 days, the maximum retention period of a manual backup is 365 days.
6. Encryption key: Select Encrypt using an Oracle-managed key or Encrypt using an customer-managed key.
  If you select a customer-managed key, you need to select one of the following key location:
  - This tenancy: You must first select the Vault and then the Key in the selected vault. You can change the compartment of the vault and key if required.
  - Different tenancy: You must enter the Encryption key OCID.
Select Copy.

The backup is copied to the same compartment in the selected region.

Note

If the COPY_BACKUP work request returns the DbSystemBackupCopyLimitExceeded error, you need to retry the copy backup again at a later time.

Using the CLI

Use the command-line interface to copy a backup of the DB system to another region.

This task requires the following:

A source backup OCID.
A policy that permits you to read and copy backups in the source region and create backups in the destination region.
A properly configured CLI installation and the requisite SSH keys. See Command Line Interface.
Note

The CLI must be configured to authenticate with the destination region to which the backup is copied.

Do the following on the CLI to copy a backup of the DB system to another region:

Open a command prompt, and run the following command:
```
oci mysql backup copy 
--source-backup-id <SourceBackupOCID> 
--source-region <SourceRegionName>
--compartment-id <DestinationCompartmentOCID> 
--region <DestinationRegionName>
--backup-copy-retention-in-days <NumberOfDays>
--display-name <DisplayName>
--description <Description>
```
- --source-backup-id: Specify the OCID of the source backup.
- --source-region: Specify the region identifier of the source backup. For example:us-ashburn-1, sa-saopaulo-1, and eu-frankfurt-1.
- --compartment-id: Specify the OCID of the destination compartment to which the backup is copied. It must be same as the compartment of the source backup.
- --region: (Optional) Specify the destination region identifier to which the backup is copied. If you do not defined the region, the region configured in the CLI config file is used.
- --backup-copy-retention-in-days: (Optional) Specify the number of days the backup in the destination region is retained. The default retention period is the same as the source backup.
- --display-name: (Optional) Specify the display name of the copied backup. If you do not define a display name, one is generated for you with the source backup display name.
- --description: (Optional) Specify the description of the copied backup. If you do not define a description, one is generated for you with the source backup description.

HeatWave Service starts to copy the source backup to the destination region.

Oracle Cloud Infrastructure Documentation