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

#include <gpudb/protocol/show_backup.h>

Public Member Functions
	ShowBackupRequest ()
	Constructs a ShowBackupRequest object with default parameters. More...

	ShowBackupRequest (const std::string &backupName_, const std::string &datasourceName_, const std::map< std::string, std::string > &options_)
	Constructs a ShowBackupRequest object with the specified parameters. More...

Public Attributes
std::string	backupName
	Name of the backup. More...

std::string	datasourceName
	Data source 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::showBackup.

Shows information about one or more backups accessible via the data source specified by datasourceName.

Definition at line 21 of file show_backup.h.

Constructor & Destructor Documentation

◆ ShowBackupRequest() [1/2]

gpudb::ShowBackupRequest::ShowBackupRequest ( )

inline

Constructs a ShowBackupRequest object with default parameters.

Definition at line 26 of file show_backup.h.

◆ ShowBackupRequest() [2/2]

gpudb::ShowBackupRequest::ShowBackupRequest	(	const std::string &	backupName_,
		const std::string &	datasourceName_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a ShowBackupRequest object with the specified parameters.

Parameters

[in]	backupName_	Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ''.
[in]	datasourceName_	Data source through which the backup is accessible.
[in]	options_	Optional parameters. show_backup_backup_id: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''. show_backup_show_contents: Show the contents of the backed-up snapshots. Supported values: show_backup_none: Don't show snapshot contents. show_backup_object_names: Show backed-up object names, and for tables, sizing detail. show_backup_object_files: Show backed-up object names, and for tables, sizing detail and associated files. The default value is show_backup_none. show_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values: show_backup_true show_backup_false The default value is show_backup_false. The default value is an empty map.

Definition at line 92 of file show_backup.h.

Member Data Documentation

◆ backupName

std::string gpudb::ShowBackupRequest::backupName

Name of the backup.

An empty string or '*' will show all existing backups. Any text followed by a '*' will show backups whose name starts with that text. The default value is ''.

Definition at line 104 of file show_backup.h.

◆ datasourceName

std::string gpudb::ShowBackupRequest::datasourceName

Data source through which the backup is accessible.

Definition at line 109 of file show_backup.h.

◆ options

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

Optional parameters.

show_backup_backup_id: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ''.
show_backup_show_contents: Show the contents of the backed-up snapshots. Supported values:
- show_backup_none: Don't show snapshot contents.
- show_backup_object_names: Show backed-up object names, and for tables, sizing detail.
- show_backup_object_files: Show backed-up object names, and for tables, sizing detail and associated files.
The default value is show_backup_none.
show_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values:
- show_backup_true
- show_backup_false
The default value is show_backup_false.

The default value is an empty map.

Definition at line 148 of file show_backup.h.

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

gpudb/protocol/show_backup.h

Public Member Functions

Public Attributes