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 to be deleted. 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::dropBackup.

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasinkName.

Definition at line 21 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 26 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 to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.
[in]	datasinkName_	Data sink through which the backup is accessible.
[in]	options_	Optional parameters. drop_backup_dry_run: Whether or not to perform a dry run of a backup deletion. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_delete_all_backups: Allow multiple backups to be deleted if true and multiple backup names are found matching backupName_. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup 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 97 of file drop_backup.h.

Member Data Documentation

◆ backupName

std::string gpudb::DropBackupRequest::backupName

Name of the backup to be deleted.

An empty string or '*' will delete all existing backups. Any text followed by a '*' will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.

Definition at line 111 of file drop_backup.h.

◆ datasinkName

std::string gpudb::DropBackupRequest::datasinkName

Data sink through which the backup is accessible.

Definition at line 116 of file drop_backup.h.

◆ options

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

Optional parameters.

drop_backup_dry_run: Whether or not to perform a dry run of a backup deletion. Supported values:
- drop_backup_true
- drop_backup_false
The default value is drop_backup_false.
drop_backup_delete_all_backups: Allow multiple backups to be deleted if true and multiple backup names are found matching backupName. Supported values:
- drop_backup_true
- drop_backup_false
The default value is drop_backup_false.
drop_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup 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 154 of file drop_backup.h.

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

gpudb/protocol/drop_backup.h

Public Member Functions

Public Attributes