/drop/backup

URL: http://<db.host>:<db.port>/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

Name

Type

Description

backup_name

string

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

string

Data sink through which the backup is accessible.

options

map 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

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'drop_backup_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /drop/backup endpoint:

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_names	array of strings	Names of backups that were deleted.
info	map of string to strings	Additional information.

Empty string in case of an error.