/create/backup

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

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by input parameter datasink_name.

Input Parameter Description

Name

Type

Description

backup_name

string

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

backup_type

string

Type of snapshot to create.

Supported Values	Description
incremental	Snapshot of changes in the database objects & data since the last snapshot of any kind.
differential	Snapshot of changes in the database objects & data since the last full snapshot.
full	Snapshot of the given database objects and data.

backup_objects_map

map of string to strings

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

Supported Parameters (keys)	Parameter Description
all	All object types and data contained in the given schemas(s).
table	Tables(s) and SQL view(s).
credential	Credential(s).
context	Context(s).
datasink	Data sink(s).
datasource	Data source(s).
stored_procedure	SQL procedure(s).
monitor	Table monitor(s) / SQL stream(s).
user	User(s) (internal and external) and associated permissions.
role	Role(s), 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: true false

datasink_name

string

Data sink through which the 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

Whether or not to calculate checksums for backup files. The default value is false. The supported values are:

true
false

ddl_only

Whether or not, for tables, to only backup DDL and not table data. The default value is false.

Supported Values	Description
true	For tables, only back up DDL, not data.
false	For tables, back up DDL and data.

max_incremental_backups_to_keep

Maximum number of incremental snapshots to keep. The default value is '-1'.

delete_intermediate_backups

Whether or not to delete any intermediate snapshots when the input parameter backup_type is set to differential. The default value is false. The supported values are:

true
false

recreate

Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. The default value is false. The supported values are:

true
false

dry_run

Whether or not to perform a dry run of a backup operation. 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

'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	ID of the snapshot created.
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.