Table(s) and SQL view(s). Tables with subscriptions will by default be restored in the state they were in at the time of the snapshot. See restore_subscriptions for options to override the default behavior.
User(s) (internal and external) and associated permissions.
Data source through which the backup will be restored.
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup.The default value is ”.
Whether or not to verify checksums for backup files when restoring.The default value is false.The supported values are:
true
false
Whether to drop live foreign-key-referencing tables that are not themselves part of the backup, when the table they reference is being replaced. Only applies when restore_policy is replace.The default value is false.
true: Drop any live table whose foreign key references a table being replaced, even when that table is not in the backup and therefore will not be restored.
false: Fail the restore of a table that is referenced by a live foreign-key table which is not part of the backup, rather than destroying data the backup cannot restore.
Behavior to apply when the schema containing any database object to restore does not already exist.The default value is true.
true: If the schema containing any restored object does not exist, create it automatically.
false: If the schema containing any restored object does not exist, return an error.
Behavior to apply when restoring tables.The default value is false.
true: Restore table DDL, but do not restore data.
false: Restore tables and their data.
Whether or not to perform a dry run of the restoration operation.The default value is false.The supported values are:
true
false
Behavior to apply when restoring datasource subscriptions on tables.The default value is resume.
resume: Resume subscriptions that were active when the backup was made.
pause: Pause subscriptions that were active when the backup was made.
cancel: Cancel active subscriptions.
Behavior to apply when restoring table data.The default value is false.
true: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
false: Restore the persisted data files directly.
If the restore_policy is rename, use this schema for relocated existing objects instead of the default generated one.The default value is ”.
Whether or not all permissions of restored principals should be restored or scoped to the restored objects.The default value is false.
true: Restore all permissions.
false: Restore only permissions on restored objects.
Behavior to apply when any database object to restore already exists.The default value is none.
none: If an object to be restored already exists with the same name, abort and return error.
replace: If an object to be restored already exists with the same name, replace it with the backup version.
rename: If an object to be restored already exists with the same name, move that existing one to the schema specified by renamed_objects_schema. This policy does not apply to non-schema objects.
Restore schema-based objects to alternate schema. Value is a comma delimitted list of key:value pairs mapping the original (source) schema name as it exists in the backup to a target (destination) schema namespace: “src: dst [, src: dst [, …]]”. Note that schema names are case sensitive and must adhere to the database schema naming criteria.The default value is ”.
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
‘restore_backup_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /restore/backup endpoint:
Show data_str
string
Value of input parameter backup_name.
long
ID of the snapshot that was restored.
long
Total size of data restored from backup.
long
Total number of files restored from backup.
long
Total number of records restored from backup.
map of string to strings
Database objects that were successfully restored and their associated types.
map of string to strings
Original and new names of database objects that were successfully restored and their associated types.
map of string to strings
Database objects that failed to be restored and their associated types.
map of string to strings
Additional information.
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.