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

CreateFullBackup task

Creates a full backup of a database.

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

    An output parameter. Internal use only.

  • database_list

    A list of databases to back up. Accepts a search query that identifies databases. The search query can be a list of database names or IDs separated by semicolons (;), or a full search. (Required)

  • host_list

    The host to store the backup on. Accepts a search query that identifies hosts. The search query can be a list of host names or IDs separated by semicolons (;), or a full search. An appropriate host is selected from this list and the backup is stored there. The default is NULL.

  • validation_type

    The type of validation. The default is 'X'.

    The following values are supported:

    • D

      Validate that all pages in the database belong to the correct object, perform a checksum validation, and validate the correctness of indexes.

    • F

      Perform a full validation.

    • S

      Perform a checksum validation.

    • X

      Perform an express validation.

    • N

      Do not perform validation.

  • expiration_date

    The date that the backup expires (i.e. the earliest date it can be automatically deleted). Not specifying this parameter means the date will be calculated based on the database's maintenance plan, while specifying NULL means that there will be no expiry date. The default is to use the date calculated using the maintenance plan.

Required privileges

BackupDatabase

Remarks

Specifying more than one host for the host parameter means that a host from that list will be chosen as the target host. Specifying NULL results in the backup being stored on a host that has enough free disk space and is not hosting any scale-out database copies of the database being backed up.

This task creates a full backup of the entire database, including all dbspace and transaction log files. The transaction log file is renamed and truncated so that future incremental backups only contain changes made since this backup.

If any form of validation is requested, there must be a cloud server capable of running the database on the specified host. If no validation is requested, no running cloud server is required.

Tenant database backups are automatically named according to the following format, and cannot be renamed: <database-name>-<date>-<F|I>#<number>

Example

Run the following task to create full backups of the databases with the tag sales and store the backups on the host myhost. The backups are checksum validated.

dbcloudcmd run CreateFullBackup database_list=tag:sales host_list=myhost validation_type=S