/admin/backup/begin

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/admin/backup/begin

Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using /admin/backup/end.

Input Parameter Description

Name Type Description
options map of string to strings Optional parameters. The default value is an empty map ( {} ).

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 'admin_backup_begin_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 /admin/backup/begin endpoint:

Name Type Description
info map of string to strings Additional information.

Empty string in case of an error.