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 to be altered. More...

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

std::string	value
	Value of the modification, depending on action. More...

std::string	datasinkName
	Data sink through which the backup is accessible. 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, accessible via the data sink specified by datasinkName.

Definition at line 22 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 27 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 to be altered.
[in]	action_	Operation to be applied. Supported values: alter_backup_checksum: Calculate checksum for backed-up files. alter_backup_ddl_only: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value_ to 'true' or 'false' for DDL only or DDL and table data, respectively. alter_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep, when taking future snapshots; set value_ to the number of snapshots to keep. alter_backup_merge: Merges all snapshots within a backup and creates a single full snapshot. alter_backup_purge: Deletes a snapshot from a backup; set value_ to the snapshot ID to purge.
[in]	value_	Value of the modification, depending on action_.
[in]	datasinkName_	Data sink through which the backup is accessible.
[in]	options_	Optional parameters. alter_backup_comment: Comments to store with the backup. alter_backup_dry_run: Whether or not to perform a dry run of a backup alteration. Supported values: alter_backup_true alter_backup_false The default value is alter_backup_false. The default value is an empty map.

Definition at line 96 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 backed-up files.
alter_backup_ddl_only: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to 'true' or 'false' for DDL only or DDL and table data, respectively.
alter_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
alter_backup_merge: Merges all snapshots within a backup and creates a single full snapshot.
alter_backup_purge: Deletes a snapshot from a backup; set value to the snapshot ID to purge.

Definition at line 133 of file alter_backup.h.

◆ backupName

std::string gpudb::AlterBackupRequest::backupName

Name of the backup to be altered.

Definition at line 108 of file alter_backup.h.

◆ datasinkName

std::string gpudb::AlterBackupRequest::datasinkName

Data sink through which the backup is accessible.

Definition at line 143 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 backup.
alter_backup_dry_run: Whether or not to perform a dry run of a backup alteration. Supported values:
- alter_backup_true
- alter_backup_false
The default value is alter_backup_false.

The default value is an empty map.

Definition at line 162 of file alter_backup.h.

◆ value

std::string gpudb::AlterBackupRequest::value

Value of the modification, depending on action.

Definition at line 138 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