Shows information about one or more
backups accessible via the
data source specified by input parameter
datasource_name.
Input Parameter Description
string
Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text.The default value is ”.
string
Data source through which the backup is accessible.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup.The default value is ”.
Show backups by type. This option is ignored if backup_id is non-empty.The default value is all.
all: Show all backup types.
full: Show full backups only.
incremental: Show incremental backups only.
differential: Show differential backups only.
Show the contents of the backed-up snapshots.The default value is none.
none: Don’t show snapshot contents.
object_names: Show backed-up object names, and for tables, sizing detail.
object_files: Show backed-up object names, and for tables, sizing detail and associated files.
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 Kinetica 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:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘show_backup_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /show/backup endpoint:
Show data_str
string
Value of input parameter backup_name.
array of maps of string to strings
Details about the overall backup(s).
array of maps of string to strings
Details about the individual snapshots contained within the backup(s).
array of maps of string to strings
When show_contents is object_names, the names of the backed-up objects as well as sizing detail of any backed-up tables; when object_files, the names of the backed-up objects as well as sizing detail and associated data files of any backed-up tables.
array of maps of string to strings
IDs of any snapshots that have been deleted from the containing backup(s).
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.