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 to restore from, which must refer to an existing backup. More...
std::map< std::string, std::string >	restoreObjectsMap
	Map of database objects to be restored from the backup. More...
std::string	datasourceName
	Data source through which the backup will be restored. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::restoreBackup.

Restores database objects from a backup accessible via the data source specified by datasourceName.

Definition at line 22 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 27 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 to restore from, which must refer to an existing backup. The default value is ''.
[in]	restoreObjectsMap_	Map of database objects to be restored from the backup. restore_backup_all: All object types and data contained in the given schemas(s). restore_backup_table: Tables(s) and SQL view(s). restore_backup_credential: Credential(s). restore_backup_context: Context(s). restore_backup_datasink: Data sink(s). restore_backup_datasource: Data source(s). restore_backup_stored_procedure: SQL procedure(s). restore_backup_monitor: Table monitor(s) / SQL stream(s). restore_backup_user: User(s) (internal and external) and associated permissions. restore_backup_role: Role(s), role members (roles or users, recursively), and associated permissions. restore_backup_configuration: If true, restore the database configuration file. Supported values: restore_backup_true restore_backup_false The default value is restore_backup_false.
[in]	datasourceName_	Data source through which the backup will be restored.
[in]	options_	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_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. The default value is restore_backup_none. 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_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_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_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_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_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. The default value is an empty map.

Definition at line 283 of file restore_backup.h.

Member Data Documentation

backupName

std::string gpudb::RestoreBackupRequest::backupName

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

The default value is ''.

Definition at line 295 of file restore_backup.h.

datasourceName

std::string gpudb::RestoreBackupRequest::datasourceName

Data source through which the backup will be restored.

Definition at line 361 of file restore_backup.h.

options

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

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_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.
  The default value is restore_backup_none.
• 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_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_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_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_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_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.

The default value is an empty map.

Definition at line 471 of file restore_backup.h.

restoreObjectsMap

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

Map of database objects to be restored from the backup.

• restore_backup_all: All object types and data contained in the given schemas(s).
• restore_backup_table: Tables(s) and SQL view(s).
• restore_backup_credential: Credential(s).
• restore_backup_context: Context(s).
• restore_backup_datasink: Data sink(s).
• restore_backup_datasource: Data source(s).
• restore_backup_stored_procedure: SQL procedure(s).
• restore_backup_monitor: Table monitor(s) / SQL stream(s).
• restore_backup_user: User(s) (internal and external) and associated permissions.
• restore_backup_role: Role(s), role members (roles or users, recursively), and associated permissions.
• restore_backup_configuration: If true, restore the database configuration file. Supported values:
  • restore_backup_true
  • restore_backup_false
  The default value is restore_backup_false.

Definition at line 356 of file restore_backup.h.

---

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

• gpudb/protocol/restore_backup.h