Skip to main content
drop_backup(backup_name=None, datasink_name=None, options=)[source]

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by input parameter datasink_name.

Parameters

backup_name (str) –

Name of the backup to be deleted. An empty string or ‘*’ will delete all existing backups. Any text followed by a ‘*’ will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.

datasink_name (str) –

Data sink through which the backup is accessible.

options (dict of str to str) –

Optional parameters. Allowed keys are:

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

    • true

    • false

    The default value is ‘false’.

  • delete_all_backups – Allow multiple backups to be deleted if true and multiple backup names are found matching input parameter backup_name. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • no_error_if_not_exists – Whether or not to suppress the error if the specified backup does not exist. 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_names (list of str) –

Names of backups that were deleted.

info (dict of str to str) –

Additional information.