/create/backup

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

Creates a database backup containing a current snapshot of existing objects.

Input Parameter Description

Name

Type

Description

backup_name

string

Name for this backup object. If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified

backup_type

string

Type of backup to create The supported values are:

incremental
differential
full

backup_objects_map

map of string to strings

Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup.

Supported Parameters (keys)	Parameter Description
all	All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
table	Database Table
credential	Credential
context	Context
datasink	Data Sink
datasource	Data Source
stored_procedure	SQL Procedure
monitor	Table Monitor (Stream)
user	User (internal and external) and associated permissions
role	Role, role members (roles or users, recursively) and associated permissions
configuration	If true, backup the database configuration file The default value is false. The supported values are: false true

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 this backup
checksum	Calculate checksum for backup files The default value is true. The supported values are: false true
ddl_only	Only save the DDL, do not backup table data The default value is false. The supported values are: true false
max_incremental_backups_to_keep	Maximum number of incremental backups to keep. The default value is '-1'.
delete_intermediate_backups	When the backup type is differential, delete any intermediate incremental or differential backups. This overrides max_incremental_backups_to_keep The default value is false. The supported values are: false true
recreate	Replace the existing backup object with a new full backup if it already exists The default value is false. The supported values are: false true
dry_run	Dry run of backup 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

'create_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 /create/backup endpoint:

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_id	long	Backup ID.
copied_bytes	long	Total size of all files copied for this snapshot
copied_files	long	Total number of files copied for this snapshot
copied_records	long	Total number of records in all files copied for this snapshot
total_number_of_records	long	Total number of records that can be restored from this snapshot
info	map of string to strings	Additional information.

Empty string in case of an error.