Managing a Backup
Use the Console or the command-line interface to edit, delete, or move a backup. You can also copy a backup to another region.
Editing a Backup
Use the Console or the command-line interface to edit the display name, description, and retention period of a DB system backup.
You cannot change the retention period of automatic backups.
The retention period of final backups of Always Free DB system is limited to a maximum of 7 days.
Use the Console or the command-line interface to edit a backup:
Using the Console
Use the Console to edit the display name, description, and retention period of your backup.
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, click Backups.
- Do one of the following:
- Click Edit from the Actions menu on the same line as your DB system.
- Click the name of the backup to open the Backup details page and click 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.
- Click Save changes.
Using the CLI
Use the command-line interface to update the display name, description, and retention period of your backup.
- 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.
Editing a Backup Plan
Edit the backup plan of an existing DB system to enable automatic backups and point in time recovery, and edit the retention period and window start time.
You cannot change the backup plan of an Always Free DB system.
Using the Console
Use the Console to edit the backup plan of an existing DB system.
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, provide the following details:
- 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 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. Click Show backup windows per region to view the default backup window specific to your region.
Note
There is no impact on the DB system or the database connections when the automatic backup is created.
- 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.
- Click Save changes.
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.
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
Use the Console to move your backup to a different compartment.
- 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.
Using the CLI
Use the command-line interface to move a backup to a different compartment.
- 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.
Deleting a Backup
Use the Console or the command-line interface to delete a backup of the DB system.
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 DB system.
- Click the name of the DB system to open the Backup details page. Click the More actions button and select Delete.
- On the Delete backup dialog box, click Delete backup.
Using the CLI
Use the command-line interface to delete a backup.
- 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.
Copying a Backup to Another Region
Copy a backup of the DB system to another region.
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.
- 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
andMYSQL_BACKUP_READ
, in the source region where the backup is located in. See mysql-backups.Note
The aggregate resource typemysql-family
does not include theMYSQL_BACKUP_COPY
permission. - The access permission,
MYSQL_BACKUP_CREATE
, in the destination region where the backup is to be copied to. See mysql-backups.
- 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
Use the Console to copy your backup to another region.
- Open the navigation menu and select Databases. Under HeatWave MySQL, click Backups.
- Do one of the following:
- Click Copy to another region from the Actions menu on the same line as your backup.
- Click the name of the backup to open the Backup details page and click Copy to another region.
- On the Copy to another region panel, provide the following details:
- Destination region: Select the region to which the backup is copied.
- Destination region compartment: The compartment cannot be changed. It always copy to the same compartment.
- Display name: (Optional) Specify the name of the backup. The default value is "
<SourceBackupName>-copy-from-<SourceRegionName>
". - Description: (Optional) Specify the description of the backup. The default value is "
This backup is a copy of <SoureBackupName> from the region <SourceRegionName>.
"
- Click Copy.
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.
- 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.