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. More...

	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. More...

Public Attributes
std::string	backupName
	Name for this backup object. More...

std::string	backupType
	Type of backup to create. More...

std::map< std::string, std::string >	backupObjectsMap
	Map of objects to be captured in the backup. More...

std::string	datasinkName
	Datasink where backup will be stored. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::createBackup.

Creates a database backup containing a current snapshot of existing objects.

Definition at line 19 of file create_backup.h.

Constructor & Destructor Documentation

◆ CreateBackupRequest() [1/2]

gpudb::CreateBackupRequest::CreateBackupRequest ( )

inline

Constructs a CreateBackupRequest object with default parameters.

Definition at line 24 of file create_backup.h.

◆ CreateBackupRequest() [2/2]

gpudb::CreateBackupRequest::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_
	)

inline

Constructs a CreateBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name for this backup object. If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified
[in]	backupType_	Type of backup to create. Supported values: create_backup_incremental create_backup_differential create_backup_full
[in]	backupObjectsMap_	Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup. create_backup_all: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions) create_backup_table: Database Table create_backup_credential: Credential create_backup_context: Context create_backup_datasink: Data Sink create_backup_datasource: Data Source create_backup_stored_procedure: SQL Procedure create_backup_monitor: Table Monitor (Stream) create_backup_user: User (internal and external) and associated permissions create_backup_role: Role, role members (roles or users, recursively) and associated permissions create_backup_configuration: If true, backup the database configuration file. Supported values: create_backup_false create_backup_true The default value is create_backup_false.
[in]	datasinkName_	Datasink where backup will be stored.
[in]	options_	Optional parameters. create_backup_comment: Comments to store with this backup create_backup_checksum: Calculate checksum for backup files. Supported values: create_backup_false create_backup_true The default value is create_backup_true. create_backup_ddl_only: Only save the DDL, do not backup table data. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_max_incremental_backups_to_keep: Maximum number of incremental backups to keep. The default value is '-1'. create_backup_delete_intermediate_backups: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides max_incremental_backups_to_keep. Supported values: create_backup_false create_backup_true The default value is create_backup_false. create_backup_recreate: Replace the existing backup object with a new full backup if it already exists. Supported values: create_backup_false create_backup_true The default value is create_backup_false. create_backup_dry_run: Dry run of backup. Supported values: create_backup_false create_backup_true The default value is create_backup_false. The default value is an empty map.

Definition at line 209 of file create_backup.h.

Member Data Documentation

◆ backupName

std::string gpudb::CreateBackupRequest::backupName

Name for this backup object.

If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified

Definition at line 223 of file create_backup.h.

◆ backupObjectsMap

std::map<std::string, std::string> gpudb::CreateBackupRequest::backupObjectsMap

Map of objects to be captured in the backup.

Error if empty and creating full backup. Error if non-empty when creating an incremental or differential backup.

create_backup_all: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
create_backup_table: Database Table
create_backup_credential: Credential
create_backup_context: Context
create_backup_datasink: Data Sink
create_backup_datasource: Data Source
create_backup_stored_procedure: SQL Procedure
create_backup_monitor: Table Monitor (Stream)
create_backup_user: User (internal and external) and associated permissions
create_backup_role: Role, role members (roles or users, recursively) and associated permissions
create_backup_configuration: If true, backup the database configuration file. Supported values:
- create_backup_false
- create_backup_true
The default value is create_backup_false.

Definition at line 280 of file create_backup.h.

◆ backupType

std::string gpudb::CreateBackupRequest::backupType

Type of backup to create.

Supported values:

Definition at line 236 of file create_backup.h.

◆ datasinkName

std::string gpudb::CreateBackupRequest::datasinkName

Datasink where backup will be stored.

Definition at line 285 of file create_backup.h.

◆ options

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

Optional parameters.

create_backup_comment: Comments to store with this backup
create_backup_checksum: Calculate checksum for backup files. Supported values:
- create_backup_false
- create_backup_true
The default value is create_backup_true.
create_backup_ddl_only: Only save the DDL, do not backup table data. Supported values:
- create_backup_true
- create_backup_false
The default value is create_backup_false.
create_backup_max_incremental_backups_to_keep: Maximum number of incremental backups to keep. The default value is '-1'.
create_backup_delete_intermediate_backups: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides max_incremental_backups_to_keep. Supported values:
- create_backup_false
- create_backup_true
The default value is create_backup_false.
create_backup_recreate: Replace the existing backup object with a new full backup if it already exists. Supported values:
- create_backup_false
- create_backup_true
The default value is create_backup_false.
create_backup_dry_run: Dry run of backup. Supported values:
- create_backup_false
- create_backup_true
The default value is create_backup_false.

The default value is an empty map.

Definition at line 354 of file create_backup.h.

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

gpudb/protocol/create_backup.h

Public Member Functions

Public Attributes