gpudb::RestoreBackupRequest

Constructs a RestoreBackupRequest object with default parameters.

Definition at line 27 of file restore_backup.h.

Constructs a RestoreBackupRequest object with the specified parameters.

Definition at line 323 of file restore_backup.h.

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

The default value is ”.

Definition at line 335 of file restore_backup.h.

Data source through which the backup will be restored.

Definition at line 406 of file restore_backup.h.

Optional parameters.

• restore_backup_backup_id: ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ”.
• restore_backup_checksum: Whether or not to verify checksums for backup files when restoring. Supported values:
  • restore_backup_true
  • restore_backup_false
  The default value is restore_backup_false.
• restore_backup_create_schema_if_not_exist: Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
  • restore_backup_true: If the schema containing any restored object does not exist, create it automatically.
  • restore_backup_false: If the schema containing any restored object does not exist, return an error.
  The default value is restore_backup_true.
• restore_backup_ddl_only: Behavior to apply when restoring tables. Supported values:
  • restore_backup_true: Restore table DDL, but do not restore data.
  • restore_backup_false: Restore tables and their data.
  The default value is restore_backup_false.
• restore_backup_dry_run: Whether or not to perform a dry run of the restoration operation. Supported values:
  • restore_backup_true
  • restore_backup_false
  The default value is restore_backup_false.
• restore_backup_restore_subscriptions: Behavior to apply when restoring datasource subscriptions on tables. Supported values:
  • restore_backup_resume: Resume subscriptions that were active when the backup was made.
  • restore_backup_pause: Pause subscriptions that were active when the backup was made.
  • restore_backup_cancel: Cancel active subscriptions.
  The default value is restore_backup_resume.
• restore_backup_reingest: Behavior to apply when restoring table data. Supported values:
  • restore_backup_true: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
  • restore_backup_false: Restore the persisted data files directly.
  The default value is restore_backup_false.
• restore_backup_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_backup_restore_policy: Behavior to apply when any database object to restore already exists. Supported values:
  • restore_backup_none: If an object to be restored already exists with the same name, abort and return error.
  • restore_backup_replace: If an object to be restored already exists with the same name, replace it with the backup version.
  • restore_backup_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.
  The default value is restore_backup_none.

The default value is an empty map.

Definition at line 534 of file restore_backup.h.

Map of database objects to be restored from the backup.

• restore_backup_all: All object types and data contained in the given schema(s).
• restore_backup_context: Context(s).
• restore_backup_credential: Credential(s).
• restore_backup_datasink: Data sink(s).
• restore_backup_datasource: Data source(s).
• restore_backup_function_environment: Python UDF function environment(s).
• restore_backup_graph: Graph(s) definition.
• restore_backup_monitor: Table monitor(s) / SQL stream(s).
• restore_backup_resource_group: Resource group(s).
• restore_backup_role: Role(s), role members (roles or users, recursively), and associated permissions.
• restore_backup_stored_procedure: SQL procedure(s).
• restore_backup_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.
• restore_backup_user: User(s) (internal and external) and associated permissions.
• restore_backup_user_defined_function: UDF(s).

Definition at line 401 of file restore_backup.h.