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

#include <gpudb/protocol/alter_backup.h>

Public Member Functions
	AlterBackupRequest ()
	Constructs an AlterBackupRequest object with default parameters. More...

	AlterBackupRequest (const std::string &backupName_, const std::string &action_, const std::string &value_, const std::string &datasinkName_, const std::map< std::string, std::string > &options_)
	Constructs an AlterBackupRequest object with the specified parameters. More...

Public Attributes
std::string	backupName
	Name of the backup object to be altered. More...

std::string	action
	Operation to be applied. More...

std::string	value
	Action specific argument. 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::alterBackup.

Alters an existing database backup containing a current snapshot of existing objects.

Definition at line 19 of file alter_backup.h.

Constructor & Destructor Documentation

◆ AlterBackupRequest() [1/2]

gpudb::AlterBackupRequest::AlterBackupRequest ( )

inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 24 of file alter_backup.h.

◆ AlterBackupRequest() [2/2]

gpudb::AlterBackupRequest::AlterBackupRequest	(	const std::string &	backupName_,
		const std::string &	action_,
		const std::string &	value_,
		const std::string &	datasinkName_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AlterBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name of the backup object to be altered
[in]	action_	Operation to be applied. Supported values: alter_backup_checksum: Calculate checksum for backup files alter_backup_ddl_only: Only save the DDL, do not backup table data alter_backup_max_incremental_backups_to_keep: Maximum number of incremental backups to keep alter_backup_merge: Merges all backup instances and creates a single full backup alter_backup_purge: Purges backup instances
[in]	value_	Action specific argument.
[in]	datasinkName_	Datasink where backup will be stored.
[in]	options_	Optional parameters. alter_backup_comment: Comments to store with the new backup instance alter_backup_dry_run: Dry run of backup changes. Supported values: alter_backup_false alter_backup_true The default value is alter_backup_false. The default value is an empty map.

Definition at line 83 of file alter_backup.h.

Member Data Documentation

◆ action

std::string gpudb::AlterBackupRequest::action

Operation to be applied.

Supported values:

alter_backup_checksum: Calculate checksum for backup files
alter_backup_ddl_only: Only save the DDL, do not backup table data
alter_backup_max_incremental_backups_to_keep: Maximum number of incremental backups to keep
alter_backup_merge: Merges all backup instances and creates a single full backup
alter_backup_purge: Purges backup instances

Definition at line 114 of file alter_backup.h.

◆ backupName

std::string gpudb::AlterBackupRequest::backupName

Name of the backup object to be altered.

Definition at line 95 of file alter_backup.h.

◆ datasinkName

std::string gpudb::AlterBackupRequest::datasinkName

Datasink where backup will be stored.

Definition at line 124 of file alter_backup.h.

◆ options

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

Optional parameters.

alter_backup_comment: Comments to store with the new backup instance
alter_backup_dry_run: Dry run of backup changes. Supported values:
- alter_backup_false
- alter_backup_true
The default value is alter_backup_false.

The default value is an empty map.

Definition at line 143 of file alter_backup.h.

◆ value

std::string gpudb::AlterBackupRequest::value

Action specific argument.

Definition at line 119 of file alter_backup.h.

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

gpudb/protocol/alter_backup.h

Public Member Functions

Public Attributes