Skip to main content
alter_backup(backup_name=None, action=None, value=None, datasink_name=None, options=)[source]

Alters an existing database backup, accessible via the data sink specified by input parameter datasink_name.

Parameters

backup_name (str) –

Name of the backup to be altered.

action (str) –

Operation to be applied. Allowed values are:

  • checksum – Calculate checksum for backed-up files.

  • ddl_only – Whether or not to only save DDL and not back up table data, when taking future snapshots; set input parameter value to ‘true’ or ‘false’ for DDL only or DDL and table data, respectively.

  • max_incremental_backups_to_keep – Maximum number of incremental snapshots to keep, when taking future snapshots; set input parameter value to the number of snapshots to keep.

  • merge – Merges all snapshots within a backup and creates a single full snapshot.

  • purge – Deletes a snapshot from a backup; set input parameter value to the snapshot ID to purge.

value (str) –

Value of the modification, depending on input parameter action.

datasink_name (str) –

Data sink through which the backup is accessible.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • comment – Comments to store with the backup.

  • dry_run – Whether or not to perform a dry run of a backup alteration. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

backup_name (str) –

Value of input parameter backup_name.

backup_id (long) –

ID of the snapshot affected by the alter operation, if any.

total_bytes (long) –

Total size of files affected by the alter operation.

total_files (long) –

Total number of files affected by the alter operation.

total_number_of_records (long) –

Total number of records affected by the alter operation.

info (dict of str to str) –

Additional information.