A set of parameters for GPUdb::createBackup. More…
#include <gpudb/protocol/create_backup.h>
Public Member Functions | |
| CreateBackupRequest () | |
| Constructs a CreateBackupRequest object with default parameters. | |
| CreateBackupRequest (const std::string &backupName_, const std::string &backupType_, const std::map< std::string, std::string > &backupObjectsMap_, const std::string &datasinkName_, const std::map< std::string, std::string > &options_) | |
| Constructs a CreateBackupRequest object with the specified parameters. | |
Public Attributes | |
| std::string | backupName |
| Name for this backup. | |
| std::string | backupType |
| Type of snapshot to create. | |
| std::map< std::string, std::string > | backupObjectsMap |
| Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot. | |
| std::string | datasinkName |
| Data sink through which the backup will be stored. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::createBackup.
Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.
Definition at line 23 of file create_backup.h.
Constructor & Destructor Documentation
◆ CreateBackupRequest() [1/2]
| inline |
Constructs a CreateBackupRequest object with default parameters.
Definition at line 28 of file create_backup.h.
◆ CreateBackupRequest() [2/2]
| inline |
Constructs a CreateBackupRequest object with the specified parameters.
Parameters
| [in] | backupName_ | Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true. |
| [in] | backupType_ | Type of snapshot to create. Supported values:
|
| [in] | backupObjectsMap_ | Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.
|
| [in] | datasinkName_ | Data sink through which the backup will be stored. |
| [in] | options_ | Optional parameters.
|
Definition at line 298 of file create_backup.h.
Member Data Documentation
◆ backupName
| std::string gpudb::CreateBackupRequest::backupName |
◆ backupObjectsMap
| std::map<std::string, std::string> gpudb::CreateBackupRequest::backupObjectsMap |
Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.
- create_backup_all: All object types and data contained in the given schema(s).
- create_backup_catalog: Data Lake catalog that is external to the database.
- create_backup_context: Context(s).
- create_backup_credential: Credential(s).
- create_backup_datasink: Data sink(s).
- create_backup_datasource: Data source(s).
- create_backup_directory: KiFS File directory(ies).
- create_backup_function_environment: Python UDF function environment(s).
- create_backup_graph: Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects.
- create_backup_monitor: Table monitor(s) / SQL stream(s).
- create_backup_resource_group: Resource group(s).
- create_backup_role: Role(s), role members (roles or users, recursively), and associated permissions.
- create_backup_stored_procedure: SQL procedure(s).
- create_backup_table: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active.
- create_backup_user: User(s) (internal and external) and associated permissions.
- create_backup_user_defined_function: UDF(s).
The default value is an empty map.
Definition at line 402 of file create_backup.h.
◆ backupType
| std::string gpudb::CreateBackupRequest::backupType |
Type of snapshot to create.
Supported values:
- create_backup_differential: Snapshot of changes in the database objects and data since the last full snapshot.
- create_backup_full: Snapshot of the given database objects and data.
- create_backup_incremental: Snapshot of changes in the database objects and data since the last snapshot of any kind.
Definition at line 330 of file create_backup.h.
◆ datasinkName
| std::string gpudb::CreateBackupRequest::datasinkName |
Data sink through which the backup will be stored.
Definition at line 407 of file create_backup.h.
◆ options
| std::map<std::string, std::string> gpudb::CreateBackupRequest::options |
Optional parameters.
- create_backup_block_table_mutations: Whether or not to block all mutations on target tables while they are being backed up. Supported values:
- create_backup_true: Block all mutations on target tables while they are being backed up.
- create_backup_false: Only block mutations on a target table at the point a disk eviction is necessary.
- create_backup_checksum: Whether or not to calculate checksums for backup files. Supported values:The default value is create_backup_false.
- create_backup_comment: Comments to store with this backup.
- create_backup_ddl_only: Whether or not, for tables, to only backup DDL and not table data. Supported values:
- create_backup_true: For tables, only back up DDL, not data.
- create_backup_false: For tables, back up DDL and data.
- create_backup_delete_intermediate_backups: Whether or not to delete any intermediate snapshots when the backupType is set to differential. Supported values:The default value is create_backup_false.
- create_backup_dry_run: Whether or not to perform a dry run of a backup operation. Supported values:The default value is create_backup_false.
- create_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep. The default value is ‘-1’.
- create_backup_recreate: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:The default value is create_backup_false.
The default value is an empty map.
Definition at line 494 of file create_backup.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/create_backup.h