Click here to view and discuss this page in DocCommentXchange. In the future, you will be sent there automatically.

SAP SQL Anywhere, on-demand edition 1.0 SP 6 » Task syntax

ForgetBackup task

Removes the metadata of all copies of the backup.

Syntax 1 (SQL)
CALL DBCloud.ForgetBackup ( backup=backup [, optional-parameters ] )
Syntax 2 (Cloud Command utility)
dbcloudcmd run ForgetBackup backup [ optional-parameters ]
Parameters
  • backup

    The ID of the backup to forget. (Required)

  • unconditionally

    Set to 1 to forget the dependent objects when forgetting the backup. If a dependent object exists, setting to 0 returns an error. The default is 0.

Required privileges

Administrator

Remarks

The ForgetBackup task forgets all copies of a particular backup, while the ForgetBackupCopy task only forgets one specific copy of a backup.

If unconditionally is set to 0, the task returns an error when the target backup is a full backup that has incremental backups, or an incremental backup that has subsequent incremental backups. If unconditionally is set to 1, the target backup, as well as any subsequent incremental backups, are forgotten.

Forgetting a cloud object should only be done if repairing the object fails, and the object cannot be dropped from the cloud.

When possible, backups should be removed from the cloud using the DeleteBackup task. The DeleteBackup task removes system resources (files, directories, and processes), and the backup's metadata from the cloud. The ForgetBackup task should be used only when the DeleteBackup task cannot be used. The ForgetBackup task does not attempt to remove or update system resources.

Since the ForgetBackup task does not delete data files, you may want to delete the backup's data files from the cloud data directory to ensure that subsequent cloud operations are not affected.

Example

Run the following task to remove the metadata of the backup with the ID BP-q7s7:

dbcloudcmd run ForgetBackup backup=BP-q7s7