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

ForgetBackupCopy task

Removes the metadata of the backup copy.

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

    The backup copy to forget. Accepts a backup copy name, ID, or a search query that identifies a single backup copy. (Required)

  • unconditionally

    Set to 1 to forget the dependent objects when forgetting the backup copy. 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 a specific backup copy.

If unconditionally is set to 0, the task returns an error when the target backup copy 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 or DeleteBackupCopy tasks. These tasks remove system resources (files, directories, and processes), and the backup's metadata from the cloud. The ForgetBackupCopy task should be used only when the DeleteBackup[Copy] tasks cannot be used. The ForgetBackupCopy task does not attempt to remove or update system resources.

Since the ForgetBackupCopy 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 from the backup copy with the ID BC-q7s7:

dbcloudcmd run ForgetBackupCopy backupcopy=BC-q7s7