gpudb::RestoreBackupRequest Struct Reference

A set of parameters for GPUdb::restoreBackup. More...

#include <gpudb/protocol/restore_backup.h>

Public Member Functions
	RestoreBackupRequest ()
	Constructs a RestoreBackupRequest object with default parameters. More...
	RestoreBackupRequest (const std::string &backupName_, const std::map< std::string, std::string > &restoreObjectsMap_, const std::string &datasourceName_, const std::map< std::string, std::string > &options_)
	Constructs a RestoreBackupRequest object with the specified parameters. More...

Public Attributes
std::string	backupName
	Name of the backup object, which must refer to a currently existing backup. More...
std::map< std::string, std::string >	restoreObjectsMap
	Map of objects to be restored from the backup. More...
std::string	datasourceName
	Datasource where backup is located. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::restoreBackup.

Restores objects from a backup instance. Response from a backup restoration operation.

Definition at line 19 of file restore_backup.h.

Constructor & Destructor Documentation

RestoreBackupRequest() [1/2]

gpudb::RestoreBackupRequest::RestoreBackupRequest ( )

inline

Constructs a RestoreBackupRequest object with default parameters.

Definition at line 24 of file restore_backup.h.

RestoreBackupRequest() [2/2]

gpudb::RestoreBackupRequest::RestoreBackupRequest ( const std::string &  backupName_, const std::map< std::string, std::string > &  restoreObjectsMap_, const std::string &  datasourceName_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a RestoreBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name of the backup object, which must refer to a currently existing backup. The default value is ''.
[in]	restoreObjectsMap_	Map of objects to be restored from the backup. Error if empty. restore_backup_all: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions) restore_backup_table: Database Table restore_backup_credential: Credential restore_backup_context: Context restore_backup_datasink: Data Sink restore_backup_datasource: Data Source restore_backup_stored_procedure: SQL Procedure restore_backup_monitor: Table Monitor (Stream) restore_backup_user: User (internal and external) and associated permissions restore_backup_role: Role, role members (roles or users, recursively) and associated permissions restore_backup_configuration: If true, restore the database configuration file. Supported values: restore_backup_false restore_backup_true The default value is restore_backup_false.
[in]	datasourceName_	Datasource where backup is located.
[in]	options_	Optional parameters. restore_backup_backup_id: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''. restore_backup_restore_policy: Behavior to apply when restoring objects that already exist. Supported values: restore_backup_none: If an object to be restored currently exists with the same name, abort and return error restore_backup_replace: If an object to be restored currently exists with the same name, replace it with the backup version restore_backup_rename: If an object to be restored currently exists with the same name, rename the original version The default value is restore_backup_none. restore_backup_renamed_objects_schema: If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. The default value is ''. restore_backup_create_schema_if_not_exist: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values: restore_backup_false restore_backup_true The default value is restore_backup_true. restore_backup_reingest: Restore table data by re-ingesting. If the cluster topology differs from the contained backup this is the default behavior, otherwise restore the persist directly. Supported values: restore_backup_false restore_backup_true The default value is restore_backup_false. restore_backup_ddl_only: Only recreates the objects from their DDL, do not restore table data. Supported values: restore_backup_true restore_backup_false The default value is restore_backup_false. restore_backup_checksum: Verify checksum for backup files. Supported values: restore_backup_false restore_backup_true The default value is restore_backup_false. restore_backup_dry_run: Does a dry-run restoration operation. Supported values: restore_backup_true restore_backup_false The default value is restore_backup_false. The default value is an empty map.

Definition at line 234 of file restore_backup.h.

Member Data Documentation

backupName

std::string gpudb::RestoreBackupRequest::backupName

Name of the backup object, which must refer to a currently existing backup.

The default value is ''.

Definition at line 246 of file restore_backup.h.

datasourceName

std::string gpudb::RestoreBackupRequest::datasourceName

Datasource where backup is located.

Definition at line 294 of file restore_backup.h.

options

std::map<std::string, std::string> gpudb::RestoreBackupRequest::options

Optional parameters.

• restore_backup_backup_id: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.
• restore_backup_restore_policy: Behavior to apply when restoring objects that already exist. Supported values:
  • restore_backup_none: If an object to be restored currently exists with the same name, abort and return error
  • restore_backup_replace: If an object to be restored currently exists with the same name, replace it with the backup version
  • restore_backup_rename: If an object to be restored currently exists with the same name, rename the original version
  The default value is restore_backup_none.
• restore_backup_renamed_objects_schema: If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. The default value is ''.
• restore_backup_create_schema_if_not_exist: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:
  • restore_backup_false
  • restore_backup_true
  The default value is restore_backup_true.
• restore_backup_reingest: Restore table data by re-ingesting. If the cluster topology differs from the contained backup this is the default behavior, otherwise restore the persist directly. Supported values:
  • restore_backup_false
  • restore_backup_true
  The default value is restore_backup_false.
• restore_backup_ddl_only: Only recreates the objects from their DDL, do not restore table data. Supported values:
  • restore_backup_true
  • restore_backup_false
  The default value is restore_backup_false.
• restore_backup_checksum: Verify checksum for backup files. Supported values:
  • restore_backup_false
  • restore_backup_true
  The default value is restore_backup_false.
• restore_backup_dry_run: Does a dry-run restoration operation. Supported values:
  • restore_backup_true
  • restore_backup_false
  The default value is restore_backup_false.

The default value is an empty map.

Definition at line 392 of file restore_backup.h.

restoreObjectsMap

std::map<std::string, std::string> gpudb::RestoreBackupRequest::restoreObjectsMap

Map of objects to be restored from the backup.

Error if empty.

• restore_backup_all: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
• restore_backup_table: Database Table
• restore_backup_credential: Credential
• restore_backup_context: Context
• restore_backup_datasink: Data Sink
• restore_backup_datasource: Data Source
• restore_backup_stored_procedure: SQL Procedure
• restore_backup_monitor: Table Monitor (Stream)
• restore_backup_user: User (internal and external) and associated permissions
• restore_backup_role: Role, role members (roles or users, recursively) and associated permissions
• restore_backup_configuration: If true, restore the database configuration file. Supported values:
  • restore_backup_false
  • restore_backup_true
  The default value is restore_backup_false.

Definition at line 289 of file restore_backup.h.

---

The documentation for this struct was generated from the following file:

• gpudb/protocol/restore_backup.h