Restore Backup

Restores database objects from a backup accessible via the data source specified by input parameter datasource_name.

Input Parameter Description

Name

Type

Description

backup_name

string

Name of the backup to restore from, which must refer to an existing backup.

The default value is ''.

restore_objects_map

map of string to strings

Map of database objects to be restored from the backup.

Supported Parameters (keys)	Parameter Description
all	All object types and data contained in the given schema(s).
context	Context(s).
credential	Credential(s).
datasink	Data sink(s).
datasource	Data source(s).
function_environment	Python UDF function environment(s).
graph	Graph(s) definition.
monitor	Table monitor(s) / SQL stream(s).
resource_group	Resource group(s).
role	Role(s), role members (roles or users, recursively), and associated permissions.
stored_procedure	SQL procedure(s).
table	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	User(s) (internal and external) and associated permissions.
user_defined_function	UDF(s).

datasource_name

string

Data source through which the backup will be restored.

options

map of string to strings

Optional parameters.

The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

backup_id

ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup.

The default value is ''.

checksum

Whether or not to verify checksums for backup files when restoring.

The default value is false.

The supported values are:

true
false

create_schema_if_not_exist

Behavior to apply when the schema containing any database object to restore does not already exist.

The default value is true.

Supported Values	Description
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.

ddl_only

Behavior to apply when restoring tables.

The default value is false.

Supported Values	Description
true	Restore table DDL, but do not restore data.
false	Restore tables and their data.

dry_run

Whether or not to perform a dry run of the restoration operation.

The default value is false.

The supported values are:

true
false

restore_subscriptions

Behavior to apply when restoring datasource subscriptions on tables.

The default value is resume.

Supported Values	Description
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.

reingest

Behavior to apply when restoring table data.

The default value is false.

Supported Values	Description
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.

renamed_objects_schema

If the restore_policy is rename, use this schema for relocated existing objects instead of the default generated one.

The default value is ''.

restore_policy

Behavior to apply when any database object to restore already exists.

The default value is none.

Supported Values	Description
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.

Output Parameter Description

Name	Type	Description
backup_name	string	Value of input parameter backup_name.
backup_id	long	ID of the snapshot that was restored.
restored_bytes	long	Total size of data restored from backup.
restored_files	long	Total number of files restored from backup.
restored_records	long	Total number of records restored from backup.
restored_objects	map of string to strings	Database objects that were successfully restored and their associated types.
renamed_objects	map of string to strings	Original and new names of database objects that were successfully restored and their associated types.
failed_objects	map of string to strings	Database objects that failed to be restored and their associated types.
info	map of string to strings	Additional information.