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

RestoreBackup task

Restores a database from a backup.

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

    The ID of the backup to restore. (Required)

  • server

    The target cloud server. Accepts a search query that identifies one cloud server, for example a cloud server name or ID. (Required)

  • include_latest_log

    Set to 1 to include the latest transaction log from the database. The default is 0.

Required privileges



The backup parameter accepts a backup ID. To view a list of backup IDs with the specified start time, run the following command:

dbcloudcmd describe "type:backup and start_time > '2012-05-02T14:20:00-04:00'"

The tenant database must be stopped.

This task restores a tenant database from either a full or incremental backup. If there is more than one copy of the backup, one is chosen randomly.

RestoreBackup deletes all copies of the tenant database including read-only scale-out database copies and the mirror, as well as the arbiter setting. If any database copies cannot be dropped, the task will fail.

After the task completes, you have a single read-write copy of the database. You must set up tenant mirroring and/or read-only scale-out systems as required.

All relevant backup files are copied to the host where the specified cloud server is running and the database is started on that cloud server.

You can only restore the backup to a cloud server that matches all the strict rules that apply to the tenant database.

Restoring a database recreates the read-write database copy. All cloud settings such as rules, tags, maintenance plans, and backups are unchanged.

This task is similar to the CreateDatabaseFromBackup task. Both tasks restore a backup, but RestoreBackup replaces the database whose backup it is restoring and requires that database be stopped. Restoring a backup is useful when a database has become corrupted or data has been lost, and you want to restore the database to a previous state. CreateDatabaseFromBackup does not require the database to be stopped and creates a new database that is an exact copy of the original database at the time of the specified backup. This task can be used to create a temporary copy of a database that can be modified without affecting the existing database.


The backupcopy parameter accepts a backup copy ID. To view a list of backup IDs with the specified start time, run the following command:

dbcloudcmd describe "type:backup and start_time > '2012-05-02T14:20:00-04:00'"

Run the following task to restore the backup with the ID BP-q5v5 and start it on the cloud server my-server#3:

dbcloudcmd run RestoreBackup backup=BP-q5v5 server=my-server#3