/alter/backup

URL: http://<db.host>:<db.port>/alter/backup

Alters an existing database backup containing a current snaphot of existing objects.

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup object to be altered

action

string

Operation to be applied

Supported Values	Description
checksum	Calculate checksum for backup files
ddl_only	Only save the DDL, do not backup table data
max_incremental_backups_to_keep	Maximum number of incremental backups to keep
merge	Merges all backup instances and creates a single full backup
purge	Purges backup instances

value

string

Action specific argument.

datasink_name

string

Datasink where backup will be stored.

options

map of string to strings

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

Supported Parameters (keys)

Parameter Description

comment

Comments to store with the new backup instance

dry_run

Dry run of backup changes The default value is false. The supported values are:

false
true

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

'alter_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 /alter/backup endpoint:

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_id	long	Backup ID.
total_bytes	long	Total size of files affected by alter operation
total_records	long	Total number of records affected alter operation
info	map of string to strings	Additional information.

Empty string in case of an error.