gpudb::DropBackupRequest Struct Reference

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

#include <gpudb/protocol/drop_backup.h>

Public Member Functions
	DropBackupRequest ()
	Constructs a DropBackupRequest object with default parameters. More...
	DropBackupRequest (const std::string &backupName_, const std::string &datasinkName_, const std::map< std::string, std::string > &options_)
	Constructs a DropBackupRequest object with the specified parameters. More...

Public Attributes
std::string	backupName
	Name of the backup object to be deleted. More...
std::string	datasinkName
	Datasink where backup is stored. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::dropBackup.

Deletes an existing database backup and all its contained snapshots.

Definition at line 17 of file drop_backup.h.

Constructor & Destructor Documentation

DropBackupRequest() [1/2]

gpudb::DropBackupRequest::DropBackupRequest ( )

inline

Constructs a DropBackupRequest object with default parameters.

Definition at line 22 of file drop_backup.h.

DropBackupRequest() [2/2]

gpudb::DropBackupRequest::DropBackupRequest ( const std::string &  backupName_, const std::string &  datasinkName_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a DropBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name of the backup object to be deleted. An empty string or '*' will delete all existing backups if true.
[in]	datasinkName_	Datasink where backup is stored.
[in]	options_	Optional parameters. drop_backup_dry_run: Dry run of drop backup. Supported values: drop_backup_false drop_backup_true The default value is drop_backup_false. drop_backup_delete_all_backups: All multiple backups to be deleted if true and multiple backup names were found matching prefix of backupName_. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_no_error_if_not_exists: If false will return an error if the provided backupName_ does not exist. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. The default value is an empty map.

Definition at line 88 of file drop_backup.h.

Member Data Documentation

backupName

std::string gpudb::DropBackupRequest::backupName

Name of the backup object to be deleted.

An empty string or '*' will delete all existing backups if true.

Definition at line 99 of file drop_backup.h.

datasinkName

std::string gpudb::DropBackupRequest::datasinkName

Datasink where backup is stored.

Definition at line 104 of file drop_backup.h.

options

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

Optional parameters.

• drop_backup_dry_run: Dry run of drop backup. Supported values:
  • drop_backup_false
  • drop_backup_true
  The default value is drop_backup_false.
• drop_backup_delete_all_backups: All multiple backups to be deleted if true and multiple backup names were found matching prefix of backupName. Supported values:
  • drop_backup_true
  • drop_backup_false
  The default value is drop_backup_false.
• drop_backup_no_error_if_not_exists: If false will return an error if the provided backupName does not exist. Supported values:
  • drop_backup_true
  • drop_backup_false
  The default value is drop_backup_false.

The default value is an empty map.

Definition at line 143 of file drop_backup.h.

---

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

• gpudb/protocol/drop_backup.h