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.