Drop Backup

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

Input Parameter Description

NameTypeDescription
backup_namestringName 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_namestringData sink through which the backup is accessible.
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
dry_run

Whether or not to perform a dry run of a backup deletion. The default value is false. The supported values are:

  • true
  • false
delete_all_backups

Allow multiple backups to be deleted if true and multiple backup names are found matching input parameter backup_name. The default value is false. The supported values are:

  • true
  • false
no_error_if_not_exists

Whether or not to suppress the error if the specified backup does not exist. The default value is false. The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
backup_namestringValue of input parameter backup_name.
backup_namesarray of stringsNames of backups that were deleted.
infomap of string to stringsAdditional information.